From 08d06be9c8276ca4f7532f44ac13f2c744847f42 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Fri, 17 Apr 2026 19:35:43 +0200 Subject: [PATCH 01/70] add chapter water use and water use releated maps, update dedication to Ad De Roo --- docs/4_Static-Maps_water-use/index.md | 116 ++++++++++++++++++++++++++ docs/_config.yml | 2 + docs/index.md | 5 +- 3 files changed, 120 insertions(+), 3 deletions(-) create mode 100644 docs/4_Static-Maps_water-use/index.md diff --git a/docs/4_Static-Maps_water-use/index.md b/docs/4_Static-Maps_water-use/index.md new file mode 100644 index 00000000..514039c4 --- /dev/null +++ b/docs/4_Static-Maps_water-use/index.md @@ -0,0 +1,116 @@ +# Water demand maps and related information + +This chapter describes the main features of time variant (transient) sectoral water demand maps for domestic, livestock, industrial, energy (cooling) sectors. +This chapter then focuses on the description of the ancillary maps required by OS LISFLOOD for the modelling of water abstraction from groundwater, surface water (channels, lakes, reservoirs), and non-conventional sources (e.g. desalination plants). +In this documentation, water demand is the amount of water required to meet the needs of the vaious uses. Water abstraction or water withdrawal (considered synonyms) is the amount of water to be abstracted from surface of groundwater resources to meet water demand requirements. Water abstraction/withdrawal is generally larger than water demand to account for leakages and other losses in the water supply system. Consumptive use is the water volume used and removed from the hydrological cycle. + +## Sectoral water demand maps + +Sectoral water demand maps indicate, for each pixel, the time-varying water demand value to supply for domestic, livestock, industrial, and thermoelectric water consumption. The segregation of the total water demand for anthropogenic use into four main sectors, namely domestic, energy, industrial and livestock water demand, enables a more accurate representation of the processes and follows the Food and Agriculture Organisation of the United Nations (FAO) terminology ([Kohli et al., 2012](https://openknowledge.fao.org/server/api/core/bitstreams/f18d9669-c967-4e37-b466-b7dc7ab78f8d/content)). +Domestic water demand represents indoor and outdoor household water use as well as other uses (e.g. industrial and urban agriculture) connected to the municipal system (e.g. water use by shops, schools and public buildings). Electricity (energy) water demand is the water use for the cooling of thermoelectric and nuclear power plants. Water demand for industry is the water used for fabricating, processing, washing, cooling or transporting products and also includes water within the final products and water used for sanitation within the manufacturing facility. Livestock demand is the water used for drinking and cleaning purposes of livestock ([Choulga et al. 2024](https://hess.copernicus.org/articles/28/2991/2024/)). + +The temporal discretization of these maps (e.g. daily, monthly, yearly update frequency) can be chosen by the modeller, mainly depending on the modelling purposes and on the available input data. The time convention is described in [this section](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) of the OS LISFLOOD model documentation. + +European 1arcmin and global 3arcmin sectoral water demand maps were generated using the OS LISFLOOD utility [water-demand-historical](https://github.com/ec-jrc/lisflood-utilities/tree/master/src/lisfloodutilities/water-demand-historic). +This user guide provides an overview of the protocol implemented to produce domestic and energy demand maps with values updated monthly, industrial and livestock demand maps with values updated yearly. The generation of the maps relies on a number of external datasets: the complete list of external datasets and step-wise instructions are provided in the readme of the OS LISFLOOD utility [water-demand-historcal](https://github.com/ec-jrc/lisflood-utilities/tree/master/src/lisfloodutilities/water-demand-historic). +[FAO AQUASTAT](https://www.fao.org/aquastat/en/) constitues the main source of information: specifically, country level data of water withdrawal. Therefore, it must be noted that, strictly speaking, these maps represent water withdrawal rather than water demand. As explained in this page, this discrepancy can be accounted for by adequately setting ancillary OS LISFLOOD inputs such as $leakage fraction$. + +Domestic water withdrawal estimates rely on FAO AQUASTAT municipal water withdrawal estimate per country and per year. Spatial disaggregation is achieved based on population data ([Global Human Settlement Layer](https://human-settlement.emergency.copernicus.eu/index_op.php)). Temporal downscaling to monthly frequency relies on monthly air temperature grids (e.g. [MSWX, Beck et al., 2022](https://journals.ametsoc.org/view/journals/bams/103/3/BAMS-D-21-0145.1.xml)) and literature parameters ([Hunag et al., 2018](https://hess.copernicus.org/articles/22/2117/2018/)) + +Industrial and energy water withdrawal estimates are based on country-scale FAO AQUASTAT industrial withdrawal data, country-scale [World Bank](https://data.worldbank.org/) manufacturing value added (MVA) data, [Global Change Analysis Model, GCAM](https://github.com/JGCRI/gcam-core/releases) regional industry and thermoelectric withdrawals, datasets avaible in the literature (e.g. Global-scale gridded estimates of thermoelectric power and manufacturing water use by [Vassolo & Doll, 2005](https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2004WR003360)). Spatial downscaling is based on population grids (due to the lack of more precise data sources). Temporal downscaling of energy water withdrawal estimates rely on temperature information. + +Country-scale livestock withdrawals estimates leverage on the difference between the FAO AQUASTAT data of agriculture and irrigation withdrawals, and on GCAM regional livestock withdrawals. Spatial downscaling is performed based on [Gridded Livestock of the World](https://www.nature.com/articles/sdata2018227). + +The protocol for the generation of water withdrawal maps relied on a number of assumptions due to the lack of homogenous and granular data at the continental and global scale. Even at the country scale, information is not available for all countries, and for all years. Gaps in space and time were filled using nearest-neighbor interpolation and linear interpolation, respectively. + + +### Groundwater bodies + +The map of groundwater bodies is a boolean map indicating the spatial distribution of groundwater exploitable resources: OS LISFLOOD allows abstraction from the lower groundwater zone only in pixels with value equal 1. + +This map can be generated using local, regional, continental, or global scale source data, depending on the specific OS LISFLOOD application. + +Examples of continental scale source data are (BGR & UNESCO) and [Africa Groundwater Atlas](https://www.bgs.ac.uk/geology-projects/africa-groundwater-atlas/) ([BGS](https://www.bgs.ac.uk/)). + +The [Groundwater Resources of the World](https://www.whymap.org/whymap/EN/Maps_Data/Gwr/gwr_node_en.html) of the World-wide Hydrogeological Mapping and Assessment Programme (WHYMAP) is an example of source data for the global domain. + +Global 3 arcmin groundwater bodies map was produced leveraging on two datasets: [Groundwater Resources of the World](https://www.whymap.org/whymap/EN/Maps_Data/Gwr/gwr_node_en.html) and the global map of bedrock elevation [GDEMM2024](https://www.nature.com/articles/s41597-024-03920-x). Albeit the first dataset was specifcally derived to highlight exploitable groundwater resources, the use of GDEMM2024 was considered useful to ensure the consistency between the global map of groudwater bodies and the available information on country-level groundwater abstraction (more details in the section **Sectoral water demand maps**). It was decided to ensure the presence of at least one groundwater pixel in all countries that reported some groundwater abstraction. According to this approach, exploitable groudwater bodies in the global 3arcmin map have larger extent than the data shown in the Groundwater Resources of the World. It is of parmount importance to acknowledge the uncertainty of the source data for the generation of water withdrawal and releated maps: the first version of the global 3arcmin map prioritized the consistency with country level data of water withdrawal (**Sectoral water demand maps**). + +European 1 arcmin groundwater bodies map was generated using the [International Hydrogeological Map of Europe, IHME1500](https://www.bgr.bund.de/EN/Themen/Grundwasser/Projekte/Flaechen-Rauminformationen/Ihme1500/ihme1500.html) v 1.2 as main data source. Specifically, groundwater resources were deemed available for the areas belonging to the following classes: I. Predominally porous rocks; II. Predominnally fissured rocks, including karstified rocks; IIIa. Locally acquiferous rocks. This approach satisfied the cross-check with available information on country level water abstraction from groundwater (for details, please see XXX). +Groundwater bodies of areas of the European extended domain (as defined in XXX) not covered by IHME1500 were derived from the global map of groundwater bodies. To avoid abrupt discontinuities, the two datasets were merged at the country level. + +### Fraction of water abstraction from groundwater, surface water, non-conventional resources +OS LISFLOOD allows water abstraction from groundwater, surface water, non-conventional sources (e.g. desalinization plants). The maps fraction of water abstraction from groundwater (fracgroundwateruse) and fraction of water abstraction from non-conventional sources (fracnonconventionalwateruse) provide information on the proportion of the total water demand that must be provided by groundwater resources and non-conventional water sources, respectively. + +Information is provided to the OS LISFLOOD code at the pixel level. However, the actual granularity of the map depends on the spatial resolution of the model exercise and on the available data. Generally speaking, spatial allocation of water demand to the three sources should be defined at the water region level. + +The fraction of water to be abstracted from groundwater, $fracgroundwateruse$, is computed in two subsequent steps. + +The first step requires the computation of fracgroundwateruse of the ratio of water withdrawal from groundwater and total water widthdrawal, both quantities are aggreagated values over the same spatial domain (e.g. water region, country). +$$ +fracgroundwateruse_1 = \frac{water withdrawal from groundwater}{total water withdrawal} +$$ +$fracgroundwateruse_1$ represents then the average value for chosen spatial domain. +Pixel values of $fracgroundwateruse$ must account for the proportion of exploitable groundwater resources within the spatial domain: $fracgroundwateruse$ must be zero in pixels with no exploitable groundwater resources, and fraction values in the remaining pixels must be adjusted accordingly. The second step is then defined as follows: + +$$ +fracgroundwateruse = min(( fracgroundwateruse_1 * \frac{area_T}{area_G} * groundwaterbodies), 1-fracnonconventionalwateruse) +$$ + +$groundwaterbodies$ is the boolean with 1 values where groundwater is available. $area_T$ and $area_G$ are the total area of the spatial domain and the area with available groundwater within the spatial domain, respectively. + +$fracnonconventionalwateruse$ is the fraction of water derived from non-conventional water sources (e.g. desalination) within the spatial domain. It is computed as the ratio of water withdrawal from groundwater and total water widthdrawal, as before, both quantities are aggreagated values over the same spatial domain (e.g. water region, country). + +$$ +fracnonconventionalwateruse = \frac{water withdrawal from non conventional sources}{total water withdrawal} +$$ + +Finally, the proportion of water demand to be satisfied by surface water resources is computed internally by OS LISFLOOD as: +$$ +fracsurfacewateruse = 1 - (fracgroundwateruse + fracnonconventionalwateruse) +$$ + +Information of water withdrawal from the three sources must be retrieved from external datasets. + +European 1arcmin and global 3arcmin maps were generated levaraging on country level information made available from [FAO AQUASTAT](https://www.fao.org/aquastat/en/). Data were retrieved in 2024: the most recent information referred to the year 2021. +The database provides information at the country level, nevertheless, information is not available for all countries, and different variables are available for different countries. +The implementented methdology aimed to maximize the exploitation of available information. +Total water withdrawal was either directly provided or defined as the sum of the other available infomration (surface water abstraction, groundwater abstraction, desalinated water, treated waste water, reuse of drained waeter from agricoluture, https://www.fao.org/aquastat/en/databases/glossary/). Groundwater withdrawal was either directly provided or computed as the complementary of the sum of the other variables. +Despite the attempt to maximize the exploitation of FAO AQUASTAT information, fraction of groundwater use could not be computed for some countries. The filling was done based on nearest neighbour approach. To avoid enforcing "extreme" scenarios to countries with no info, only values in the interval [0.15, 0.85] were transferred from the closest neighbors. If the three closest countries did not have information or had values outside of the interval [0.15, 0.85], the fill value was 0.5. +When using FAO AQUASTAT database, water withdrawal from non conventional sources was defined equal to the variable 'desalinated water produced'. Conutries were the latter variable was not availeble were allocated 0 value of $fractionofnonconventional$ water use. It is here noted that this water source is "outside" of the hydrological cycle modelled by LISFLOOD (oceans are not modelled!). Desalination plants processing water of lakes in landlocked countries are, on the contrary, retrieving water from the hydrological cycle modelled by LISFLOOD: to be consistent with the model implementation, the latter quantied did not contribute to the computation of $fractionofnonconventional$ water use, but were added to the abstraction from surface water bodies. + +Clearly, leveraging on country level information leads to changes along the country borders which are generally not consistent with the physical groundwater and surface water basins. Where possible, it is recommmeded to use information at the basin or water region scale. + +### Fraction of consumptive water use +The fraction of consumptive water use defines the portion of water abstraction which is consumed and leaves the hydrological cycle. It applies to domestic, livestock, energy (cooling), and industrial uses; each fraction can be set independently as a constant for the entire modelling domain (by introducing the desired values in the OS LISFLOOD settings file) or as a map including more granular information, ideally segregated according to water regions. + +Fractions of consumptive water use maps are currently not available for the European 1arcmin and global 3arcmin domains. Constant value were retrieved from the report of [Bisselink et al, 2018](https://publications.jrc.ec.europa.eu/repository/handle/JRC110927): 0.2 domestic consumptive use, 0.15 livestock consumptive use, 0.17 energy consumptive use, 0.15 industrial consumptive use. + +### Irrigation efficiency, irrigation conveyance efficiency, irrigation multiplier +Water demand for irrigation is computed internally by the code according to soil mosture decific and crop type. +Irrigation efficiency, irrigation conveyance efficiency, irrigation multiplier are used to adjust the water demand to compute the volume to be abstracted for irrigation. +This value, included between 0 and 1, can be a constant over the entire modelling domain (by introducing the desired values in the OS LISFLOOD settings file) or a map. +The European 1arcmin domain makes use of a map with data at the level of NUTS2 regions and information retreived from [De Roo et al, 2020](https://publications.jrc.ec.europa.eu/repository/handle/JRC120388) (Figure 3, Benitez et al, 2018). +The global 3arcmin domain currently makes use of 0.75 constant value, as indicated in [Bisselink et al, 2018](https://publications.jrc.ec.europa.eu/repository/handle/JRC110927). +Conveyance efficiency depends on how water is delivered to the fields, it is always included between 0 and 1, the lower the value, the larger the water abstraction for irrigation. It can be a constant value or a map. European 1 arcmin and global 3arcmin domains curretly use 0.8 constant value, as indicated in [Bisselink et al, 2018](https://publications.jrc.ec.europa.eu/repository/handle/JRC110927). +Irrigation multiplier is a factor larger than 1 applied to increase water demand for irrigation, to mimic the additioanl water abstraction required to prevent soil salinitization. The currently implemented value is 1.2. + +### Domestic leakage fraction and domestic water saving fraction +Domestic leakage fraction is used to account for the leakages from pipes in urban water supply systems: this value must be lower than 1, 0 indicates absence of leakages. Within the code, domestic leakage fraction values larger than 0 are used to compute a multiplier (>1) of water demand for domestic use to compute water abstraction for domestic use. +Conversely, domestic water saving fraction reduces water demand, and, consequently, water abstraction. +For both inputs, OS LISFLOOD accepts a constant value or a map. The reports [Bisselink et al, 2018](https://publications.jrc.ec.europa.eu/repository/handle/JRC110927) and [De Roo et al, 2020](https://publications.jrc.ec.europa.eu/repository/handle/JRC120388) provide information on domestic leakage and water saving fraction, respectively. +In the current European 1arcmin and global 3arcmin set-ups,domestic leakage fraction is set to 0: water demnad maps are computed leveraging on water withdrawal values reported by FAO AQUASTAT[https://www.fao.org/aquastat/en/], which should, by definition, already account for leakages. + +### Water regions map +As the spatial resolution of the model increases, the assumption of coincidence between demand and abstraction locations within the same model grid cell becomes increasingly invalid. To address this limitation, the concept of water regions is introduced. A water region is defined as a subcatchment where demand and abstraction activities occur, allowing for a more accurate representation of the spatial relationships between these processes. +*Water regions* are generally defined by sub-river-basins within a Country. In order to mimick reality, it is advisable to avoid cross-Country-border abstractions. Whenever information is available, it is strongly recommended to align the *water regions* with the actual areas managed by water management authorities, such as regional water boards. In Europe, the River Basin Districts, as defined in the Water Framework Directive and subdivided by country, can be used. + +#### Consistency between water region map and model calibration protocol + +Water resourses (surface water bodies and groundwater) are shared inside the water region in order to meet the cumulative requirements of the entire water region area. For this reason, it is strongly recommended to include the entire water region(s) in the modelled area. If a portion of the water region is not included in the modelled area, then LISFLOOD cannot adequately compute the water demand and abstraction (it is important to notice that LISFLOOD will not crush but the results will be affected by this discrepancy). + +**The inclusion of the complete water region in the computational domain becomes compulsory when performing catchment-based calibration, where parameters are optimized separately for each catchment inside the larger computational domain**. In this case, calibrated parameters are optmised for a specific model model domain. Each calibration domain must include a finite number of water regions (and each water region must be entirely included in one catchment). If and only if this condition is not met, the calibrated parameters can be correctly optimised. Conversely, when a water region belongs to one or more calibration catchments, the water resources are allocated and abstracted in different quantities during calibration as opposed to the modelling of the entire basin. + +The utility [waterregions](https://github.com/ec-jrc/lisflood-utilities) can be used to 1) verify the consistency between calibration catchments and water regions or 2) create a water region map which is consistent with a set of calibration points. + +Current European 1arcmin and global 3arcmin water regions map were generated to meet the requirement explained above. The list of calibration points, a basemap of the major surface water basins, and the map of country borders were used as input to the OS LISFLOOD utility in the case of the European 1arcmin domain. The list of calibration points and the map of country borders were used as input in the case of the global 3arcmin domain. \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index 806d9cca..4250689a 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -241,6 +241,8 @@ defaults: url: 4_Static-Maps_reservoirs-lakes - title: "Rice calendar maps" url: 4_Static-Maps_rice-calendar + - title: "Water use and water use related maps" + url: 4_Static-Maps_water-use - title: "Static maps: appendix" url: 4_Static-Maps_appendix diff --git a/docs/index.md b/docs/index.md index edd10330..8e8daa41 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ ![](./media/image2.png) ------------------------------------ -It is with deep sadness that we inform you that on Monday 26th September, our beloved colleague, and the creator of Lisflood, Ad de Roo passed away. +This user guide is dedicated to the memory of our beloved colleague, and the creator of Lisflood, Ad de Roo, who passed away on 26th September 2022.
Ad was an internationally renowned hydrologist, who never ceased to share his knowledge and enthusiasm, to the benefit of many JRC and Commission colleagues, and indeed to the European Union. @@ -10,8 +10,7 @@ He was a scientist and educator to his core. During an exceptional career, he pu Ad’s ability to push the boundaries of science and to see the applications of said science has been at the heart of the LISFLOOD model that serves hydrologists and the wider academic community worldwide for their research. LISFLOOD is also the core of the European and Global Flood Awareness Systems. Whilst these started as research projects under his leadership and guidance, they have become cornerstones of the operational Copernicus Emergency Management service. As such, Ad’s science regularly serves to improve Europeans abilities to tackle flood related disasters. Ad provided a safe space for his students and early-career colleagues, helping them to flourish and make the best of their skills for our institution. He provided scientific advice to peers, and was always a highly professional, dependable, reliable and much valued colleague. -Enyone who's ever met Ad remembers him with a smile, with kind words and easy going attitude. We will mourn now, and then continue to work on his Lisflood legacy.
- +Enyone who's ever met Ad remembers him with a smile, with kind words and easy going attitude. We pledge to continue working on his Lisflood legacy.
------------------------------------ LISFLOOD User Guide From c0eb2d25cd3878e0c2ea521c0565017093c5cdc3 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Fri, 17 Apr 2026 19:38:42 +0200 Subject: [PATCH 02/70] small edit water use and water use releated maps --- docs/4_Static-Maps_water-use/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/4_Static-Maps_water-use/index.md b/docs/4_Static-Maps_water-use/index.md index 514039c4..ef2aa8d8 100644 --- a/docs/4_Static-Maps_water-use/index.md +++ b/docs/4_Static-Maps_water-use/index.md @@ -1,4 +1,4 @@ -# Water demand maps and related information +# Water use maps and water use related information This chapter describes the main features of time variant (transient) sectoral water demand maps for domestic, livestock, industrial, energy (cooling) sectors. This chapter then focuses on the description of the ancillary maps required by OS LISFLOOD for the modelling of water abstraction from groundwater, surface water (channels, lakes, reservoirs), and non-conventional sources (e.g. desalination plants). From d7f6e20508a440a1b0ca22d35c5b26c977d0fae7 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Fri, 17 Apr 2026 19:40:33 +0200 Subject: [PATCH 03/70] small edit water use and water use releated maps --- docs/4_Static-Maps_water-use/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/4_Static-Maps_water-use/index.md b/docs/4_Static-Maps_water-use/index.md index ef2aa8d8..65962ed8 100644 --- a/docs/4_Static-Maps_water-use/index.md +++ b/docs/4_Static-Maps_water-use/index.md @@ -66,6 +66,7 @@ fracnonconventionalwateruse = \frac{water withdrawal from non conventional sour $$ Finally, the proportion of water demand to be satisfied by surface water resources is computed internally by OS LISFLOOD as: + $$ fracsurfacewateruse = 1 - (fracgroundwateruse + fracnonconventionalwateruse) $$ From 476b7fe5b57a086ba73941d2b306809fb4f5f2d2 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Fri, 17 Apr 2026 19:46:29 +0200 Subject: [PATCH 04/70] small edit water use and water use releated maps --- docs/4_Static-Maps_water-use/index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/4_Static-Maps_water-use/index.md b/docs/4_Static-Maps_water-use/index.md index 65962ed8..ef878692 100644 --- a/docs/4_Static-Maps_water-use/index.md +++ b/docs/4_Static-Maps_water-use/index.md @@ -36,8 +36,8 @@ The [Groundwater Resources of the World](https://www.whymap.org/whymap/EN/Maps_D Global 3 arcmin groundwater bodies map was produced leveraging on two datasets: [Groundwater Resources of the World](https://www.whymap.org/whymap/EN/Maps_Data/Gwr/gwr_node_en.html) and the global map of bedrock elevation [GDEMM2024](https://www.nature.com/articles/s41597-024-03920-x). Albeit the first dataset was specifcally derived to highlight exploitable groundwater resources, the use of GDEMM2024 was considered useful to ensure the consistency between the global map of groudwater bodies and the available information on country-level groundwater abstraction (more details in the section **Sectoral water demand maps**). It was decided to ensure the presence of at least one groundwater pixel in all countries that reported some groundwater abstraction. According to this approach, exploitable groudwater bodies in the global 3arcmin map have larger extent than the data shown in the Groundwater Resources of the World. It is of parmount importance to acknowledge the uncertainty of the source data for the generation of water withdrawal and releated maps: the first version of the global 3arcmin map prioritized the consistency with country level data of water withdrawal (**Sectoral water demand maps**). -European 1 arcmin groundwater bodies map was generated using the [International Hydrogeological Map of Europe, IHME1500](https://www.bgr.bund.de/EN/Themen/Grundwasser/Projekte/Flaechen-Rauminformationen/Ihme1500/ihme1500.html) v 1.2 as main data source. Specifically, groundwater resources were deemed available for the areas belonging to the following classes: I. Predominally porous rocks; II. Predominnally fissured rocks, including karstified rocks; IIIa. Locally acquiferous rocks. This approach satisfied the cross-check with available information on country level water abstraction from groundwater (for details, please see XXX). -Groundwater bodies of areas of the European extended domain (as defined in XXX) not covered by IHME1500 were derived from the global map of groundwater bodies. To avoid abrupt discontinuities, the two datasets were merged at the country level. +European 1 arcmin groundwater bodies map was generated using the [International Hydrogeological Map of Europe, IHME1500](https://www.bgr.bund.de/EN/Themen/Grundwasser/Projekte/Flaechen-Rauminformationen/Ihme1500/ihme1500.html) v 1.2 as main data source. Specifically, groundwater resources were deemed available for the areas belonging to the following classes: *I. Predominally porous rocks; II. Predominnally fissured rocks, including karstified rocks; IIIa. Locally acquiferous rocks*. This approach satisfied the cross-check with available information on country level water abstraction from groundwater (for details, please see **Sectoral water demand maps**). +Groundwater bodies of areas of the European extended domain (as defined in the [introduction to the static maps](https://ec-jrc.github.io/lisflood-code/4_Static-Maps-introduction/)) not covered by IHME1500 were derived from the global map of groundwater bodies. To avoid abrupt discontinuities, the two datasets were merged at the country level. ### Fraction of water abstraction from groundwater, surface water, non-conventional resources OS LISFLOOD allows water abstraction from groundwater, surface water, non-conventional sources (e.g. desalinization plants). The maps fraction of water abstraction from groundwater (fracgroundwateruse) and fraction of water abstraction from non-conventional sources (fracnonconventionalwateruse) provide information on the proportion of the total water demand that must be provided by groundwater resources and non-conventional water sources, respectively. @@ -47,9 +47,11 @@ Information is provided to the OS LISFLOOD code at the pixel level. However, the The fraction of water to be abstracted from groundwater, $fracgroundwateruse$, is computed in two subsequent steps. The first step requires the computation of fracgroundwateruse of the ratio of water withdrawal from groundwater and total water widthdrawal, both quantities are aggreagated values over the same spatial domain (e.g. water region, country). + $$ fracgroundwateruse_1 = \frac{water withdrawal from groundwater}{total water withdrawal} $$ + $fracgroundwateruse_1$ represents then the average value for chosen spatial domain. Pixel values of $fracgroundwateruse$ must account for the proportion of exploitable groundwater resources within the spatial domain: $fracgroundwateruse$ must be zero in pixels with no exploitable groundwater resources, and fraction values in the remaining pixels must be adjusted accordingly. The second step is then defined as follows: From 960a6db97ea524c03aa960d908d916f4973e4e8c Mon Sep 17 00:00:00 2001 From: fuchsiger <67674846+fuchsiger@users.noreply.github.com> Date: Tue, 21 Apr 2026 17:01:29 +0200 Subject: [PATCH 05/70] Update 3_step5_model-init docs --- docs/3_step5_model-initialisation/index.md | 79 ++++++++++++---------- 1 file changed, 43 insertions(+), 36 deletions(-) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index 83c9bc72..c2163403 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -2,10 +2,15 @@ Just as any other hydrological model, LISFLOOD needs to know the initial state (i.e. amount of water stored) of its internal state variables in order to be able to produce reasonable discharge simulations. However, in practice we hardly ever know the initial state of all state variables at a given time. Hence, we have to estimate the state of the initial storages in a reasonable way, which is also called the initialisation of a hydrological model. -In this subsection we will first demonstrate the effect of the model's initial state on the results of a simulation, explain the steady-state storage in practice and then explain you in detail how to initialize LISFLOOD. +In this subsection we will: + 1. demonstrate the effect of the model's initial state on simulation results + 2. explain the theory of initialisation and the steady-state storage concept + 3. explain how to run the initialisation (pre-run) for kinematic and split routing configurations + 4. describe how to use the pre-run outputs to set up a cold start + 5. describe how to complete the initialisation in temporal chunks when needed -## The impact of the model's initial state on simulation results +## 4.1 The impact of the model's initial state on simulation results To better understand the impact of the initial model state on the results of a simulation, let's start with a simple example. The Figure below shows 3 LISFLOOD simulations of soil moisture for the upper soil layer. In the first simulation, it was assumed that the soil is initially completely saturated. In the second one, the soil was assumed to be completely dry (i.e. at residual moisture content). Finally, a third simulation was done where the initial soil moisture content was assumed to be in between these two extremes. @@ -13,21 +18,21 @@ To better understand the impact of the initial model state on the results of a s **Figure:** *Simulation of soil moisture in upper soil layer for a soil that is initially at saturation (s), at residual moisture content (r) and in between (\[s+r\]/2)* -What is clear from the Figure is that the initial amount of moisture in the soil only has a marked effect on the start of each simulation; after a few months the three curves converge. In other words, the "memory" of the upper soil layer only goes back a few months (or, more precisely, for time lags of more than about 8 months the autocorrelation in time is negligible). +What is clear from the Figure is that the initial amount of moisture in the soil only has a marked effect on the start of each simulation; after a few months the three curves converge. In other words, the "memory" of the upper soil layer only goes back a few months (or, more precisely, for time lags of more than about 8 months the autocorrelation in time is negligible). In theory, this behaviour provides a convenient and simple way to initialise a model such as LISFLOOD. Suppose we want to do a simulation of the year 1995. We obviously don't know the state of the soil at the beginning of that year. However, we can get around this by starting the simulation a bit earlier than 1995, say one year. In that case we use the year 1994 as a *warm-up* period, assuming that by the start of 1995 the influence of the initial conditions (i.e. 1-1-1994) is negligible. The very same technique can be applied to initialise LISFLOOD's other state variables, such as the amounts of water in the lower soil layer, the upper groundwater zone, the lower groundwater zone, and in the channel. -## The theory of initialisation +## 4.2 The theory of initialisation When setting up a **model cold run**, most of the internal state variables can be simply set to 0 at the start of the run. For example, this applies to the initial snow cover (*SnowCoverInitValue*), frost index (*FrostIndexInitValue*), interception storage (*CumIntInitValue*). The initial value of the 'days since last rainfall event' (*DSLRInitValue*) is typically set to 1. -For soil and groundwater state variables, initialisation is somewhat less straightforward. The amount of water that can be stored in the three soil layers (*ThetaInit1aValue*,*ThetaInit1bValue*, *ThetaInit2Value*) is limited by the soil's porosity. The lower groundwater zone poses special problems because of its overall slow response (discussed in a separate section below). Because of this, LISFLOOD provides the possibility to initialise these variables internally. The following Table summarises these special initialisation methods: +For soil and groundwater state variables, initialisation is somewhat less straightforward. The amount of water that can be stored in the three soil layers (*ThetaInit1Value*, *ThetaInit2Value*, *ThetaInit3Value*) is limited by the soil's porosity. The lower groundwater zone poses special problems because of its overall slow response (discussed in a separate section below). Because of this, LISFLOOD provides the possibility to initialise these variables internally. The following Table summarises these special initialisation methods: **Table:** *LISFLOOD special initialisation methods*$^1$ | **Variable** | **Description** | **Initialisation method** | |-------------------------------|-------------------------------|-------------------------------| -| ThetaInit1Value /
ThetaForestInit2Value | initial soil moisture content
upper soil layer (V/V)| set to soil moisture content
at field capacity | +| ThetaInit1Value /
ThetaForestInit1Value | initial soil moisture content
upper soil layer (V/V)| set to soil moisture content
at field capacity | | ThetaInit2Value /
ThetaForestInit2Value | initial soil moisture content
lower soil layer (V/V) | set to soil moisture content
at field capacity | | LZInitValue /
LZForestInitValue | initial water in lower
groundwater zone (mm) | set to steady-state storage | | TotalCrossSectionArea
InitValue | initial cross-sectional area
of water in channels | set to half of bankfull depth | @@ -42,27 +47,28 @@ The issue above can occur, for instance, in catchments with arid climate and ver To avoid nonrealistic results in such specific contexts, an improved initialization scheme has been implemented in OS-LISFLOOD v5.0.0. -Initialization of the soil moisture content: the prerun provides in output end states and average fluxes. The end states are the volumetric soil moisture content for the three soil layers and the three land covers (9 maps). The average fluxes represent the averaege (over the simulation period) infiltration from the soil layer 2 to soil layer 3, for the three land cover fractions (3 maps). In the cold run, the end states are used to initialize the volumetric soil moisture content of soil layers 1 and 2. The initilization of the volumetric soil moisture content of soil layer 3 makes use of the relevant end state and of the fluxes: following the same reasoning implemented for the lower groundwater zone (see below), the model tries to enable long term equilibrium conditions between average inflow and outflow fluxes in the third soil layer. Accounting for an adequate spin-up period of the initialization run allows to compute realistic average fluxes values. This latter outcome can be achieved by adequately setting the value of NumDaysSpinUp. +**Initialization of the soil moisture content**: the prerun provides in output end states and average fluxes. The end states are the volumetric soil moisture content for the three soil layers and the three land covers (9 maps). The average fluxes represent the average infiltration (over the simulation period) from the soil layer 2 to soil layer 3, for the three land cover fractions (3 maps indicated as *SeepTopToSubBAverageXX*). In the cold run, the end states are used to initialise the volumetric soil moisture content of soil layers 1 and 2. The initialisation of the volumetric soil moisture content of soil layer 3 makes use of the relevant end state and of the fluxes, following the same reasoning implemented for the lower groundwater zone (see below), the model tries to enable long term equilibrium conditions between average inflow and outflow fluxes in the third soil layer. In more detail, for soil layer 3, the average seepage maps as well as an .end map are produced that later serves as a starting guess for solving the second-order, non-linear Van Genuchten equation. Accounting for an adequate spin-up period of the initialization run allows and is recommended to compute realistic average fluxes values. This latter outcome can be achieved by adequately setting the value of *NumDaysSpinUp*. -Initialization of the upper groundwater zone water content: it is recommended to use the end state generated by the prerun.
+**Initialization of the upper groundwater zone** water content: it is recommended to use the end state generated by the prerun.
*Please note that the content of this paragraph does not apply to the runs with warm start!*
**Initialisation of the lower groundwater zone** -Even though the use of a sufficiently long warm-up period usually results in a correct initialisation, a complicating factor is that the time needed to initialise any storage component of the model is dependent on the average residence time of the water in it. For example, the moisture content of the upper soil layer tends to respond almost instantly to LISFLOOD's meteorological forcing variables (precipitation, evapo(transpi)ration). As a result, relatively short warm-up periods are sufficient to initialise this storage component. At the other extreme, the response of the lower groundwater zone is generally very slow (especially for large values of $T_{lz}$). Consequently, to avoid unrealistic trends in the simulations, very long warm-up periods may be needed. The Figure below shows a typical example for an 8-year simulation, in which a decreasing trend in the lower groundwater zone is visible throughout the whole simulation period. Because the amount of water in the lower zone is directly proportional to the baseflow in the channel, this will obviously lead to an unrealistic long-term simulation of baseflow. Assuming the long-term climatic input is more or less constant, the baseflow (and thus the storage in the lower zone) should be free of any long-term trends (although some seasonal variation is normal). In order to avoid the need for excessive warm-up periods, LISFLOOD is capable of calculating a 'steady-state' storage amount for the lower groundwater zone. This *steady state* storage is very effective for reducing the lower zone's warm-up time. The concept of *steady state* is explained in the [LISFLOOD model description](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/), here we will show how it can be used to speed up the initialisation of a LISFLOOD run. +Even though the use of a sufficiently long warm-up period usually results in a correct initialisation, a complicating factor is that the time needed to initialise any storage component of the model is dependent on the average residence time of the water in it. For example, the moisture content of the upper soil layer tends to respond almost instantly to LISFLOOD's meteorological forcing variables (precipitation, evapo(transpi)ration). As a result, relatively short warm-up periods are sufficient to initialise this storage component. At the other extreme, the response of the lower groundwater zone is generally very slow (especially for large values of $T_{lz}$). Consequently, to avoid unrealistic trends in the simulations, very long warm-up periods may be needed. The Figure below shows a typical example for an 8-year simulation, in which a decreasing trend in the lower groundwater zone is visible throughout the whole simulation period. Because the amount of water in the lower zone is directly proportional to the baseflow in the channel, this will obviously lead to an unrealistic long-term simulation of baseflow. Assuming the long-term climatic input is more or less constant, the baseflow (and thus the storage in the lower zone) should be free of any long-term trends (although some seasonal variation is normal). In order to avoid the need for excessive warm-up periods, LISFLOOD is capable of calculating a *steady-state* storage amount for the lower groundwater zone. This *steady state* storage is very effective for reducing the lower zone's warm-up time. The concept of *steady state* is explained in the [LISFLOOD model description](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/), here we will show how it can be used to speed up the initialisation of a LISFLOOD run. **Steady-state storage in practice** -An actual LISFLOOD simulation differs from the theoretical *steady state* in 2 ways. First, in any real simulation the inflow into the lower zone is not constant, but varies in time. This is not really a problem, since $LZ_{ss}$ can be computed from the *average* recharge. However, this is something we do not know until the end of the simulation! Also, the inflow into the lower zone is controlled by the availability of water in the upper zone, which, in turn, depends on the supply of water from the soil. Hence, it is influenced by any calibration parameters that control behaviour of soil- and subsoil (e.g. $T_{uz}$, $GW_{perc}$, $b$, and so on). This means that -when calibrating the model- the average recharge will be different for every parameter set. Note, however, that it will *always* be smaller than the value of $GW_{perc}$, which is used as an upper limit in the model. -As an alternative to using the internal initialization (and hence the bogus values), LZavin and AvgDis (LZInitValue and PrevDischarge) can be computed using an initialization run (or pre-run). The pre-run procedure must include a sufficiently long warm-up period to allow the computation of reliable values of LZavin and AvgDis. The set-up of the initialization run is explained below: the protocol differs slightly depending on the settings of the option split routing. +An actual LISFLOOD simulation differs from the theoretical *steady state*: +The steady-state storage $LZ_{ss}$ is directly proportional to the average recharge into the lower groundwater zone. In practice, this average recharge cannot be known a priori for two reasons: it varies in time rather than being constant, and it is controlled by the availability of water in the upper groundwater zone, which in turn depends on the supply of water from the soil. Hence, during calibration the average recharge will differ for every parameter set since it depends on soil and subsoil parameters (e.g. $T_{uz}$, $GW_{perc}$, $b$, and so on). Note, however, that the average recharge will *always* be smaller than the value of $GW_{perc}$, which is used as an upper limit in the model. Therefore $LZ_{ss}$ and hence the correct initial storage can only be reliably estimated after running the model via *average* recharge, which is one of the purpose of the pre-run. +As an alternative to using the internal initialization (and hence the bogus values), LZavin and AvgDis (LZInitValue and PrevDischarge) can be computed using an initialization run (or pre-run). The pre-run procedure must include a sufficiently long warm-up period to allow the computation of reliable values of LZavin and AvgDis. The set-up of the initialization run is explained in Section 4.3; the protocol differs slightly depending on the settings of the split routing option. -## What you need to do: +## 4.3 What you need to do: ### Option 1: If using Kinematic routing only (no split routing): -1) Set initial state of all state variables to either 0,1 or -9999 (i.e. cold start with default values or internally initialized values) in Settings.XML file +1) Set initial state of all state variables to either 0,1 or -9999 (i.e. cold start with default values or internally initialised values) in Settings.XML file 2) Activate the “InitLisfloodwithoutsplit” and the "InitLisflood" options in section of Settings.XML file using: ```xml @@ -87,7 +93,7 @@ As an alternative to using the internal initialization (and hence the bogus valu 3) Activate reporting maps (in NetCDF format) in section of Settings.XML file using: ```xml - + ``` 4) Set split routing option to not active in section of Settings.XML file using: @@ -127,9 +133,9 @@ Similarly, set the name of the reporting map for the end states in sect - + ``` 4) Set split routing option to active in section of Settings.XML file using: @@ -187,7 +193,8 @@ Similarly, set the name of the reporting map for the end states in sect + ``` This tells the model to write the values of all state variables (averages, upstream of contributing area to each gauge) to time series files. The default name of the lower zone time series is ‘lzUps.tss’. @@ -209,13 +216,13 @@ This tells the model to write the values of all state variables (averages, upstr -ii) The prerun will then created a number (from 1 to 17, depending on the .xml settings) of maps NetCDF format. Copy those maps (found in folder "out", see the setting $(PathOut) above) into the folder "init" ($(PathInit)) +ii) The prerun will then create a number (from 1 to 17, depending on the .xml settings) of maps in NetCDF format. Copy those maps (found in folder "out", see the setting $(PathOut) above) into the folder "init" ($(PathInit)) The following list enumerates the files required for the correct execution of the LISFLOOD Cold Start: - * lzavin.nc (striclty required) + * lzavin.nc (strictly required) - * avgdis.nc (strictly required only when using SplitRouting) + * avgdis.nc (strictly required, but only when using SplitRouting) * uz.end.nc, groundwater upper zone water content - other land cover fraction (strongly recommended) @@ -233,9 +240,9 @@ The following list enumerates the files required for the correct execution of th * thf2.end.nc, soil moisture - forest land cover fraction - second layer (strongly recommended) - * thf3.end.nc, soil moisture - forest land cover fraction - third layer (strongly recommended) + * thf3.end.nc, soil moisture - forest land cover fraction - third layer (strongly recommended) - * thi1.end.nc, soil moisture - irrigation land cover fraction - first layer (strongly recommended) + * thi1.end.nc, soil moisture - irrigation land cover fraction - first layer (strongly recommended) * thi2.end.nc, soil moisture - irrigation land cover fraction - second layer (strongly recommended) @@ -243,11 +250,11 @@ The following list enumerates the files required for the correct execution of th * SeepTopToSubBAverageOtherMap.nc, average flux from second to third soil layer - other land cover fraction (strongly recommended) - * SeepTopToSubBAverageForestMap.nc, average flux from second to third soil layer - forest land cover fraction (strongly recommended) - - * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction (strongly recommended) + * SeepTopToSubBAverageForestMap.nc, average flux from second to third soil layer - forest land cover fraction (strongly recommended) + * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction (strongly recommended) +With strongly recommended we mean that the produced .end maps of the initialization run are used as start values of the model run (cold start). ```xml ************************************************************** @@ -314,15 +321,15 @@ lisflood settings.xml -## Completing the LISFLOOD initialization in a number of temporal chunks +## 4.5 Running the initialisation in temporal chunks Due to specific settings of the computational infrastructure (e.g. timewall that limits the maximum duration of a job), it might be necessary to complete the LISFLOOD initialization in chunks. As an example, the full initialization period 02/01/1980-01/01/2025 must be computed in three temporal chunks (a) 02/01/1980 00:00 - 01/01/1995 00:00, (b) 02/01/1995 00:00 - 01/01/2010 00:00, (c) 02/01/2010 00:00 - 01/01/2025 00:00 -Starting with LISFLOOD v5, the computation of the initialization run in temporal chunk can be performed by following the instructions belo (the same instructions apply with SplitRouting on or off) +Starting with LISFLOOD v5, the computation of the initialization run in temporal chunk can be performed by following the instructions below (the same instructions apply with SplitRouting on or off) -**Prerun(a): cold start** +**Prerun (a): cold start** ```xml @@ -400,7 +407,7 @@ Starting with LISFLOOD v5, the computation of the initialization run in temporal ``` -Prerun(a) generates the following intermediate outputs: +Prerun (a) generates the following intermediate outputs: -End files of state variables -LZInflowCUMEnd, @@ -410,7 +417,7 @@ Prerun(a) generates the following intermediate outputs: -cumSeepTopToSubBIrrigationEnd, -TimeSinceStartPrerunChunkEnd. -**Prerun(b): warm start** +**Prerun (b): warm start** ```xml @@ -487,7 +494,7 @@ Prerun(a) generates the following intermediate outputs: ``` -Prerun(b) uses the intermediate outputs of prerun(a) and generates an update of the same end variables for the intermediate chunk (b): +Prerun (b) uses the intermediate outputs of prerun(a) and generates an update of the same end variables for the intermediate chunk (b): -End files of state variables -LZInflowCUMEnd, @@ -498,7 +505,7 @@ Prerun(b) uses the intermediate outputs of prerun(a) and generates an update of -TimeSinceStartPrerunChunkEnd. -**Prerun(c): warm start** +**Prerun (c): warm start** ```xml @@ -519,7 +526,7 @@ Prerun(b) uses the intermediate outputs of prerun(a) and generates an update of ``` -Prerun(c) uses the intermediate outputs of prerun(b) and returns the ouputs for the full initialization period (in the example above, prerun(c) reports the results for 02/01/1980 00:00 - 01/01/2025 00:00). +Prerun(c) uses the intermediate outputs of prerun(b) and returns the outputs for the full initialization period (in the example above, prerun(c) reports the results for 02/01/1980 00:00 - 01/01/2025 00:00). Therefore, Prerun(c) generates all the files to be used for the LISFLOOD Cold Start. These outputs are: @@ -555,4 +562,4 @@ These outputs are: * SeepTopToSubBAverageForestMap.nc, average flux from second to third soil layer - forest land cover fraction - * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction \ No newline at end of file + * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction From 8b8caa727be538d6c728704968e234d6453859a9 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 22 Apr 2026 16:06:01 +0200 Subject: [PATCH 06/70] update description lakes map, add description lakes table --- docs/4_Static-Maps_reservoirs-lakes/index.md | 55 ++++++++++++++------ 1 file changed, 40 insertions(+), 15 deletions(-) diff --git a/docs/4_Static-Maps_reservoirs-lakes/index.md b/docs/4_Static-Maps_reservoirs-lakes/index.md index 9477e27f..3e608566 100644 --- a/docs/4_Static-Maps_reservoirs-lakes/index.md +++ b/docs/4_Static-Maps_reservoirs-lakes/index.md @@ -1,14 +1,14 @@ # Reservoirs and lakes Lakes and reservoirs can be defined as a significant volume of water, which occupies a depression of the land and has no direct connection with a sea. They can intensify winter snowstorms, increase precipitation or/and surface temperature, generate night convection and intensive thunderstorms. Lakes and reservoirs can influence the atmosphere regionally and globally.
- + Lake mask map -In the LISFLOOD model lake mask map represents the area covered by lakes and is used for computing evaporation from open water surfaces. - + Lakes & reservoirs maps -In the LISFLOOD model lakes and reservoirs maps represent only outflow location grid-cells (store lake/reservoir ID number in the morphological parameter look-up table) and are used for the lakes and reservoirs modelling. +The modelling of lakes and reservoirs requires three maps and a set of txt files. + ## Lake mask map +The lake mask map represents the area covered by lakes and reservoirs, it is used for computing evaporation from open water surfaces. + ### General map information and possible source data | Map name | File name;type | Units; range | Description | @@ -38,28 +38,53 @@ If a grid-cell has any fraction of inland water and is inside the GLWD Level 1 a *Figure 53: Lakemask map at 1 arc min horizontal resolution for European domain (left) and at 3 arc min horizontal resolution for Global domain (right) with coloured areas showing land pixel.* +## Reservoirs map and tables +Reservoirs having degree of regulation below 0.08 are more accurately modelled as lakes. -## Lakes and reservoirs maps +## Lakes map and tables +Lakes are identified using a unique integer number (ID). +The lakes map represent the outflow location of a lake: each outflow point has the ID of the relevant lake. Modelling of lakes within OS LISFLOOD then requires the following pieces of information: lake surface area, average inflow to the lake, width of the lake outlet. The latter information is provuided to the code in .txt format (these txt files are traditionally called OS LISFLOOD tables). -### General map information and possible source data +### General map and tables information and possible source data -| Map name | File name;type | Units; range | Description | +| Map/table name | File name; type | Units; range | Description | | :---| :--- | :--- | :--- | -|Lakes|lakes.nc;
Type: Float32|Units: -;
Range: integer ID number to identify each lake |Lake outflow location
(stores lake ID number in the morphological parameter look-up table)| -|Reservoirs|res.nc;
Type: Float32|Units: -;
Range: integer ID number to identify each reservoir |Reservoir outflow location
(stores reservoir ID number in the morphological parameter look-up table)| +|Lakes|lakes.nc;
Type: Float32|Units: -;
Range: integer ID number to identify each lake |Lake outflow location
(stores lake ID number in the metadata file)| +|lakea| lakea.txt;
2 columms: ID VALUE; 1 row for each lake|Units: m|Width of the outltet of the lake| +|lakerea| lakearea.txt;
2 columms: ID VALUE; 1 row for each lake|Units: m2|Lake surface area| +|lakeavginflow| lakeavginflow.txt;
2 columms: ID VALUE; 1 row for each lake|Units: m3/s|Average inflow to the lake| -| Source data| Reference/preparation | Temporal coverage | Spatial information | -| :---| :--- | :--- | :--- | -|Lakes datase|NA|NA|European/Global, ASCII table| -|Reservoirs dataset|NA|NA|European/Global, ASCII table| -|Local Drain Direction (LDD) map| It can be prepared by following the methodology explained [here](../4_Static-Maps_topography)|NA|Global| +[HydroLAKES](https://www.hydrosheds.org/products/hydrolakes) is a relevant example of source of data for lakes map and tables. ### Methodology -Any ASCII tables with lakes and reservoirs geographical location should be mapped on the local drain direction (ldd) map. +As a first step, it is recommended to create a file including all lakes information required by OS LISFLOOD and some relevant metadata that can help with model analysis and results description. +Essential information are + +1. Lake unique identifier, selected by the user or taken from external datasets; +2. Geographic oordinates of the lake outlet; +3. Coordinates of the lake outlet mapped on OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)); +4. Lake surface area; +5. Lake outlet width; +6. Average inflow to the lake. + +Optional metadata are: +7. Lake catchment area [km2 or m2] +8. Lake name +9. Lake country +10. Lake identifier in other dataset +11. Source of information 4,5,6 + +Lake unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the lake map. Geographic oordinates of the lake outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3), for this step, the comparison between lake catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/) is strongly recommended. + +Lake surface area can be retrieved from local datasets or global datasets such as HydroLAKES](https://www.hydrosheds.org/products/hydrolakes), [GLWD](https://www.hydrosheds.org/products/glwd), [GRAND](https://www.globaldamwatch.org/grand). +Where lake outlet width cannot be retrieved from external datdaset, it can be measured with GIS tools. +Finally, lake average inflow can be retrieved from observed time series (where available) or numerical model results. +Lake maps and tables of the European 1arcmin domain and global 3arcmin domain are based on information from [HydroLAKES](https://www.hydrosheds.org/products/hydrolakes). +Lake outlet width was generally measured with GIS tools; lake average inflow was computed using OS LISFLOOD CEMS EFAS and CEMS GloFAS discharge reanalysis (GloFASv4 reanalysis for GloFASv5 tables; EFASv5 naturalized flow for EFASv6 tables). From 0053c11352f62854a683e85bdf0c2c2fda6b4dda Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 22 Apr 2026 17:29:43 +0200 Subject: [PATCH 07/70] update description reservoirs map, add description reservoirs table --- docs/4_Static-Maps_reservoirs-lakes/index.md | 79 +++++++++++++++++--- 1 file changed, 69 insertions(+), 10 deletions(-) diff --git a/docs/4_Static-Maps_reservoirs-lakes/index.md b/docs/4_Static-Maps_reservoirs-lakes/index.md index 3e608566..1b9b496a 100644 --- a/docs/4_Static-Maps_reservoirs-lakes/index.md +++ b/docs/4_Static-Maps_reservoirs-lakes/index.md @@ -38,14 +38,67 @@ If a grid-cell has any fraction of inland water and is inside the GLWD Level 1 a *Figure 53: Lakemask map at 1 arc min horizontal resolution for European domain (left) and at 3 arc min horizontal resolution for Global domain (right) with coloured areas showing land pixel.* + ## Reservoirs map and tables -Reservoirs having degree of regulation below 0.08 are more accurately modelled as lakes. +Reservoirs are identified using a unique integer number (ID). +The reservoirs map shows the outflow location of each reservoir: each outflow point has the ID of the relevant reservoir. Modelling of reservoirs within OS LISFLOOD then requires the following pieces of information: reservoir storage, minimum reservoir outflow, normal reservoir outflow, flood reservoir outflow (connected to 100 year return period discharge). The latter information is provuided to the code in .txt format (these txt files are traditionally called OS LISFLOOD tables). + +### General map and tables information and possible source data + +| Map/table name | File name; type | Units; range | Description | +| :---| :--- | :--- | :--- | +|Reservoirs|res.nc;
Type: Float32|Units: -;
Range: integer ID number to identify each lake |Reservoir outflow location
(stores lake ID number in the metadata file)| +|Reservoir Total Storage| res_storage.txt;
2 columms: ID VALUE; 1 row for each reservoir|Units: m3|Reservoir capacity| +|Reservoir Flood outflow| res_flood_outflow.txt;
2 columms: ID VALUE; 1 row for each reservoir|Units: m3/s|Reservoir Flood outflow| +|Reseervoir normal outflow| res_normal_outflow.txt;
2 columms: ID VALUE; 1 row for each reservoir|Units: m3/s|Normal outflow| +|Reseervoir minimum outflow| res_min_outflow.txt;
2 columms: ID VALUE; 1 row for each reservoire|Units: m3/s|Minimum outlfow| + +The well-known Global Reservoir and Dam Database[GDW](https://www.globaldamwatch.org/grand) now superseeded by the Global Dam Watch [GDW](https://www.globaldamwatch.org/database) is a relevant example of source of data for lakes map and tables. + +### Methodology +As a first step, it is recommended to create a file including all reservoir information required by OS LISFLOOD and some relevant metadata that can help with model analysis and results description. +Essential information are: + +1. reservoir unique identifier, selected by the user or taken from external datasets; +2. Geographic oordinates of the reservoir outlet; +3. Coordinates of the reservoir outlet mapped on OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)); +4. Reservoir storage capacity; +5. Reservoir normal outflow; +6. Reservoir minimum ouflow; +7. Reservoir flood outflow. + +Optional metadata are: + +7. Reservoir catchment area [e.g. km2] +8. Reservoir surface area [e.g. km2] +9. Reservoir name +10. River, basin, country +11. Year of construction +12. Year of removal +13. Degree of regulation in years, DOR +14. Main purpose(s) +15. Source of information 4,5,6,7,8,9 (and others) + +The following paragraphs provide guidelines for the generation of the reservoir map and tables. + +Reservoir unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the reservoirs map. Geographic oordinates of the reservoirs outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3), for this step, the comparison between reservoir catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/) is strongly recommended. + +Reservoir storage capcaity can be retrieved from local datasets or global datasets such as [GDW](https://www.globaldamwatch.org/grand). + +Reservoir normal outflow, minimum outflow, flood outflow can also be derived from in situ observations, local datasets or global datasets. Where such information is not avaible, users can implement the following approximations: reservoir normal outflow can be approximated by river average discharge (from measurements or numerical simulations); reservoir minimum outflow can be approximated by environmental discharge (from regulations or numerical approximation); resrervoir flood outflow can be approaximated by 100-year return period of river discharge discharge. + +The degree of regulation can be computes as the quotient between reservoir capacity (Units: MCM) and normal reservoir outflow (units: m3/s). It is recommented to model reservoirs with low degree of regulation (e.g. lower than 0.08) as lakes. + +Reservoir maps and tables of the European 1arcmin domain and global 3arcmin domain are mainly based on information from [GDW](https://www.globaldamwatch.org/grand). +Reservoirs included in the European 1arcmin domain had a minimum volume of 10 hm3, a minimum upstream catchment area of 50 km2, degree of regulation larger or equal to 0.08. +Lakes included in the global 3arcmin domain had a minimum volume of 100 hm3, a minimum upstream catchment area of 250 km2, degree of regulation larger or equal to 0.08. +Reservoir normal, nminimum, flood outflow were computed using OS LISFLOOD CEMS EFAS and CEMS GloFAS discharge reanalysis (GloFASv4 reanalysis upstream of the reservoir for GloFASv5 tables; EFASv5 naturalized flow simulation for EFASv6 tables). ## Lakes map and tables Lakes are identified using a unique integer number (ID). -The lakes map represent the outflow location of a lake: each outflow point has the ID of the relevant lake. Modelling of lakes within OS LISFLOOD then requires the following pieces of information: lake surface area, average inflow to the lake, width of the lake outlet. The latter information is provuided to the code in .txt format (these txt files are traditionally called OS LISFLOOD tables). +The lakes map shows the outflow location of each lake: each outflow point has the ID of the relevant lake. Modelling of lakes within OS LISFLOOD then requires the following pieces of information: lake surface area, average inflow to the lake, width of the lake outlet. The latter information is provuided to the code in .txt format (these txt files are traditionally called OS LISFLOOD tables). ### General map and tables information and possible source data @@ -62,7 +115,7 @@ The lakes map represent the outflow location of a lake: each outflow point has t ### Methodology As a first step, it is recommended to create a file including all lakes information required by OS LISFLOOD and some relevant metadata that can help with model analysis and results description. -Essential information are +Essential information are: 1. Lake unique identifier, selected by the user or taken from external datasets; 2. Geographic oordinates of the lake outlet; @@ -72,11 +125,15 @@ Essential information are 6. Average inflow to the lake. Optional metadata are: -7. Lake catchment area [km2 or m2] -8. Lake name -9. Lake country -10. Lake identifier in other dataset -11. Source of information 4,5,6 + +7. Lake catchment area [e.g. km2] +8. Lake volume [e.g. hm3] +9. Lake name +10. River, basin, country +11. Lake identifier in other dataset +12. Source of information 4,5,6,7,8 + +The following paragraphs provide guidelines for the generation of the lake map and tables. Lake unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the lake map. Geographic oordinates of the lake outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3), for this step, the comparison between lake catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/) is strongly recommended. @@ -86,5 +143,7 @@ Where lake outlet width cannot be retrieved from external datdaset, it can be me Finally, lake average inflow can be retrieved from observed time series (where available) or numerical model results. -Lake maps and tables of the European 1arcmin domain and global 3arcmin domain are based on information from [HydroLAKES](https://www.hydrosheds.org/products/hydrolakes). -Lake outlet width was generally measured with GIS tools; lake average inflow was computed using OS LISFLOOD CEMS EFAS and CEMS GloFAS discharge reanalysis (GloFASv4 reanalysis for GloFASv5 tables; EFASv5 naturalized flow for EFASv6 tables). +Lake maps and tables of the European 1arcmin domain and global 3arcmin domain are based on information from [HydroLAKES](https://www.hydrosheds.org/products/hydrolakes): waterbodies classified in HydroLakes as natural lake were considered for inclusion into the lakes dataset. +Lakes included in the European 1arcmin domain had a minimum volume of 10 hm3, a minimum lake surface area of 5 km2, a minimum upstream catchment area of 50 km2. +Lakes included in the global 3arcmin domain had a minimum volume of 100 hm3, a minimum lake surface area of 50 km2, a minimum upstream catchment area of 250 km2. +Lake outlet width was generally measured with GIS tools; lake average inflow was computed using OS LISFLOOD CEMS EFAS and CEMS GloFAS discharge reanalysis (GloFASv4 reanalysis for GloFASv5 tables; EFASv5 naturalized flow for EFASv6 tables). \ No newline at end of file From 54de6577827ad9412c193b222b0d7b279365a75d Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 22 Apr 2026 18:07:35 +0200 Subject: [PATCH 08/70] small changes reservoirs and lakes chapter --- docs/4_Static-Maps_reservoirs-lakes/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/4_Static-Maps_reservoirs-lakes/index.md b/docs/4_Static-Maps_reservoirs-lakes/index.md index 1b9b496a..87697f1b 100644 --- a/docs/4_Static-Maps_reservoirs-lakes/index.md +++ b/docs/4_Static-Maps_reservoirs-lakes/index.md @@ -82,7 +82,7 @@ Optional metadata are: The following paragraphs provide guidelines for the generation of the reservoir map and tables. -Reservoir unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the reservoirs map. Geographic oordinates of the reservoirs outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3), for this step, the comparison between reservoir catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/) is strongly recommended. +Reservoir unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the reservoirs map. Geographic oordinates of the reservoirs outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3). Adequate model representation requires the agreement between reservoir catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/). Reservoir storage capcaity can be retrieved from local datasets or global datasets such as [GDW](https://www.globaldamwatch.org/grand). @@ -135,7 +135,7 @@ Optional metadata are: The following paragraphs provide guidelines for the generation of the lake map and tables. -Lake unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the lake map. Geographic oordinates of the lake outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3), for this step, the comparison between lake catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/) is strongly recommended. +Lake unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the lake map. Geographic oordinates of the lake outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3). Adequate model representation requires the agreement between lake catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/). Lake surface area can be retrieved from local datasets or global datasets such as HydroLAKES](https://www.hydrosheds.org/products/hydrolakes), [GLWD](https://www.hydrosheds.org/products/glwd), [GRAND](https://www.globaldamwatch.org/grand). From 820d3e59558bad8523e8f0f669b63e0f5bd65753 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 22 Apr 2026 20:02:32 +0200 Subject: [PATCH 09/70] add environmental flow description --- docs/4_Static-Maps_water-use/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/4_Static-Maps_water-use/index.md b/docs/4_Static-Maps_water-use/index.md index ef878692..c2426a72 100644 --- a/docs/4_Static-Maps_water-use/index.md +++ b/docs/4_Static-Maps_water-use/index.md @@ -104,6 +104,12 @@ Conversely, domestic water saving fraction reduces water demand, and, consequent For both inputs, OS LISFLOOD accepts a constant value or a map. The reports [Bisselink et al, 2018](https://publications.jrc.ec.europa.eu/repository/handle/JRC110927) and [De Roo et al, 2020](https://publications.jrc.ec.europa.eu/repository/handle/JRC120388) provide information on domestic leakage and water saving fraction, respectively. In the current European 1arcmin and global 3arcmin set-ups,domestic leakage fraction is set to 0: water demnad maps are computed leveraging on water withdrawal values reported by FAO AQUASTAT[https://www.fao.org/aquastat/en/], which should, by definition, already account for leakages. +### Environmental flow +Environmental flow is defined as the amount of water which should be always present in a river to ensure the survival (or well-being) of the aquatic ecosystem. In OS LISFLOOD, Environmental Flow is a lower threshold: water abstraction for the channel stops when discharge is lower than such a threshold. +OS LISFLOOD accepts either a constant value or a map as input. These values could be defined by water management plans of by statistical analysis (e.g. 10th percentile of a naturalized simulation, i.e. a simulation without water use, lakes, reservoirs). +It is here noted that OS LISFLOOD equally ensures a minimum water volume in lakes and reservoirs: these minimum values are set internally by the code, as explained in the Water Use chapter. + + ### Water regions map As the spatial resolution of the model increases, the assumption of coincidence between demand and abstraction locations within the same model grid cell becomes increasingly invalid. To address this limitation, the concept of water regions is introduced. A water region is defined as a subcatchment where demand and abstraction activities occur, allowing for a more accurate representation of the spatial relationships between these processes. *Water regions* are generally defined by sub-river-basins within a Country. In order to mimick reality, it is advisable to avoid cross-Country-border abstractions. Whenever information is available, it is strongly recommended to align the *water regions* with the actual areas managed by water management authorities, such as regional water boards. In Europe, the River Basin Districts, as defined in the Water Framework Directive and subdivided by country, can be used. From 0e64842fb27c241c5b8c6c0edd4dd5369ad9888a Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 23 Apr 2026 16:33:34 +0200 Subject: [PATCH 10/70] add units water demand maps --- docs/4_Static-Maps_water-use/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/4_Static-Maps_water-use/index.md b/docs/4_Static-Maps_water-use/index.md index c2426a72..027cc558 100644 --- a/docs/4_Static-Maps_water-use/index.md +++ b/docs/4_Static-Maps_water-use/index.md @@ -9,7 +9,7 @@ In this documentation, water demand is the amount of water required to meet the Sectoral water demand maps indicate, for each pixel, the time-varying water demand value to supply for domestic, livestock, industrial, and thermoelectric water consumption. The segregation of the total water demand for anthropogenic use into four main sectors, namely domestic, energy, industrial and livestock water demand, enables a more accurate representation of the processes and follows the Food and Agriculture Organisation of the United Nations (FAO) terminology ([Kohli et al., 2012](https://openknowledge.fao.org/server/api/core/bitstreams/f18d9669-c967-4e37-b466-b7dc7ab78f8d/content)). Domestic water demand represents indoor and outdoor household water use as well as other uses (e.g. industrial and urban agriculture) connected to the municipal system (e.g. water use by shops, schools and public buildings). Electricity (energy) water demand is the water use for the cooling of thermoelectric and nuclear power plants. Water demand for industry is the water used for fabricating, processing, washing, cooling or transporting products and also includes water within the final products and water used for sanitation within the manufacturing facility. Livestock demand is the water used for drinking and cleaning purposes of livestock ([Choulga et al. 2024](https://hess.copernicus.org/articles/28/2991/2024/)). -The temporal discretization of these maps (e.g. daily, monthly, yearly update frequency) can be chosen by the modeller, mainly depending on the modelling purposes and on the available input data. The time convention is described in [this section](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) of the OS LISFLOOD model documentation. +The temporal discretization of these maps (e.g. daily, monthly, yearly update frequency) can be chosen by the modeller, mainly depending on the modelling purposes and on the available input data. Values must be expressed in $[\frac{mm}{day}]$, for any update frequency and for any modelling computational step. The usage of the data in case of frequency of update larger than one day (e.g. monthly updates) is described in [this section](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) of the model documentation. Similarly to the meteorological forcings, OS LISFLOOD internally adjusts daily input values to the sub-daily modelling step. European 1arcmin and global 3arcmin sectoral water demand maps were generated using the OS LISFLOOD utility [water-demand-historical](https://github.com/ec-jrc/lisflood-utilities/tree/master/src/lisfloodutilities/water-demand-historic). This user guide provides an overview of the protocol implemented to produce domestic and energy demand maps with values updated monthly, industrial and livestock demand maps with values updated yearly. The generation of the maps relies on a number of external datasets: the complete list of external datasets and step-wise instructions are provided in the readme of the OS LISFLOOD utility [water-demand-historcal](https://github.com/ec-jrc/lisflood-utilities/tree/master/src/lisfloodutilities/water-demand-historic). From 5c8ac43bd1f048ed9709083a7f6cf5e34155a812 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 10:18:14 +0200 Subject: [PATCH 11/70] update Annex State Variables --- docs/4_annex_state-variables/index.md | 86 ++++++++++++++------------- 1 file changed, 46 insertions(+), 40 deletions(-) diff --git a/docs/4_annex_state-variables/index.md b/docs/4_annex_state-variables/index.md index d7ceb191..e01bd022 100644 --- a/docs/4_annex_state-variables/index.md +++ b/docs/4_annex_state-variables/index.md @@ -1,41 +1,47 @@ -**Table:** *State variables.* +**Table:** *State variables, required for warm start of model simulations.* -| Key | LISFLOOD file name | LISFLOOD variable | Unit | Description | -|--------------------------------|--------------------|-----------------------| ---- |---------------------------------------------------------------------------------------------| -| OFDirectState | ofdir | OFM3Direct | m3 | Water volume on catchment surface for direct fraction [m3] | -| OFOtherState | ofoth | OFM3Other | m3 | Water volume on catchment surface for other fraction [m3] | -| OFForestState | offor | OFM3Forest | m3 | Water volume on catchment surface for forest fraction [m3] | -| ChanCrossSectionState | chcro | TotalCrossSectionArea | m | Total cross-section area of channel | -| DSLRState | dslr | DSLR[0] | day | Reported days since last rain | -| DSLRForestState | dslf | DSLR[1] | day | Reported days since last rain for forest | -| DSLRIrrigationState | dsli | DSLR[2] | day | Reported days since last rain irrigation | -| SnowCoverAState | scova | SnowCoverS[0] | mm | Reported snow cover in snow zone A [mm] | -| SnowCoverBState | scovb | SnowCoverS[1] | mm | Reported snow cover in snow zone B [mm] | -| SnowCoverCState | scovc | SnowCoverS[2] | mm | Reported snow cover in snow zone C [mm] | -| FrostIndexState | frost | FrostIndex | C/day| Reported frost index | -| CumInterceptionState | cum | CumInterception[0] | mm | Reported interception storage | -| CumInterceptionForestState | cumf | CumInterception[1] | mm | Reported interception storage for forest | -| CumInterceptionIrrigationState | cumi | CumInterception[2] | mm | Reported interception storage for irrigation | -| Theta1State | tha | Theta1a[0] | - | Reported volumetric soil moisture content for top soil layer 1a [V/V] | -| Theta1ForestState | thfa | Theta1a[1] | - | Reported volumetric soil moisture content for top soil layer 1a forest fraction [V/V] | -| Theta1IrrigationState | thia | Theta1a[2] | - | Reported volumetric soil moisture content for top soil layer 1a irrigation fraction [V/V] | -| Theta2State | thb | Theta1b[0] | - | Reported volumetric soil moisture content for soil layer 1b [V/V] | -| Theta2ForestState | thfb | Theta1b[1] | - | Reported volumetric soil moisture content for soil layer 1b forest fraction [V/V] | -| Theta2IrrigationState | thib | Theta1b[2] | - | Reported volumetric soil moisture content for soil layer 1b irrigation fraction [V/V] | -| Theta3State | thc | Theta2[0] | - | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| Theta3ForestState | thfc | Theta2[1] | - | Reported volumetric soil moisture content for soil layer 2 forest fraction [V/V] | -| Theta3IrrigationState | thic | Theta2[2] | - | Reported volumetric soil moisture content for soil layer 2 irrigation fraction [V/V] | -| UZState | uz | UZ[0] | mm | Reported storage in upper groundwater zone response box [mm] | -| UZForestState | uzf | UZ[1] | mm | Reported storage in upper groundwater zone response box for forest [mm] | -| UZIrrigationState | uzi | UZ[2] | mm | Reported storage in upper groundwater zone response box for irrigation [mm] | -| LZState | lz | LZ | mm | Reported storage in lower response box [mm] | -| CumIntSealedState | cseal | CumInterSealed | mm | Reported cumulative depressions storage [mm] | -| DischargeMaps | dis | ChanQAvg | m3/s | Reported average discharge over the model time step (not used for warm start) [m3/s] | -| ChanQState | chanq | ChanQ | m3/s | Reported istantaneous discarge at end of the model time step [m3/s] | -| ChanQAvgDtState | chanqavgdt | ChanQAvgDt | m3/s | Reported average discarge for the last routing sub-step [m3/s] | -| LakeLevelState | lakeh | LakeLevel | m | Output map(s) with lake level [m] | -| LakePrevInflowState | lakeprevinq | LakeInflowOld | m3/s | Output map with lake average inflow at previous routing sub-step (ChanQ(t-1)) [m3/s] | -| LakePrevOutflowState | lakeprevoutq | LakeOutflow | m3/s | Output map with lake average outflow at previous routing sub-step (ChanQ(t-1)) [m3/s] | -| ReservoirFillState | rsfil | ReservoirFill | - | Output map(s) with Reservoir Filling [V/V] | -| CrossSection2State | ch2cr | CrossSection2Area | m2 | Cross section area for split routing [m2] | -| ChSideState | chside | Sideflow1Chan | m2/s | Sideflow to channel for 1st line of routing [m2/s] | +| Key | LISFLOOD file name | LISFLOOD variable | Unit | Description | +|--------------------------------|--------------------|-----------------------| ---- |---------------------------------------------------------------------------------------------------| +| OFDirectState | ofdir | OFM3Direct | m3 | Water volume on catchment surface for direct fraction | +| OFOtherState | ofoth | OFM3Other | m3 | Water volume on catchment surface for other fraction | +| OFForestState | offor | OFM3Forest | m3 | Water volume on catchment surface for forest fraction | +| ChanCrossSectionState | chcro | TotalCrossSectionArea | m2 | Total cross-section area of channel | +| DSLRState | dslr | DSLR[0] | day | Reported days since last rain | +| DSLRForestState | dslf | DSLR[1] | day | Reported days since last rain for forest | +| DSLRIrrigationState | dsli | DSLR[2] | day | Reported days since last rain irrigation | +| SnowCoverAState | scova | SnowCoverS[0] | mm | Reported snow cover in snow zone A | +| SnowCoverBState | scovb | SnowCoverS[1] | mm | Reported snow cover in snow zone B | +| SnowCoverCState | scovc | SnowCoverS[2] | mm | Reported snow cover in snow zone C | +| FrostIndexState | frost | FrostIndex | C/day| Reported frost index | +| CumInterceptionState | cum | CumInterception[0] | mm | Reported interception storage | +| CumInterceptionForestState | cumf | CumInterception[1] | mm | Reported interception storage for forest | +| CumInterceptionIrrigationState | cumi | CumInterception[2] | mm | Reported interception storage for irrigation | +| CumIntSealedState | cseal | CumInterSealed | mm | Reported cumulative depressions storage | +| Theta1State | tha | Theta1a[0] | - | Reported volumetric soil water content for superficial soil layer (1a), other fraction [V/V] | +| Theta1ForestState | thfa | Theta1a[1] | - | Reported volumetric soil water content for superficial soil layer (1a), forest fraction [V/V] | +| Theta1IrrigationState | thia | Theta1a[2] | - | Reported volumetric soil water content for superficial soil layer (1a), irrigation fraction [V/V] | +| Theta2State | thb | Theta1b[0] | - | Reported volumetric soil water content for upper soil layer (1b), other fraction [V/V] | +| Theta2ForestState | thfb | Theta1b[1] | - | Reported volumetric soil water content for upper soil layer (1b), forest fraction [V/V] | +| Theta2IrrigationState | thib | Theta1b[2] | - | Reported volumetric soil water content upper soil layer (1b), irrigation fraction [V/V] | +| Theta3State | thc | Theta2[0] | - | Reported volumetric soil water content for lower soil layer (2), other fraction [V/V] | +| Theta3ForestState | thfc | Theta2[1] | - | Reported volumetric soil water content for lower soil layer (2), forest fraction [V/V] | +| Theta3IrrigationState | thic | Theta2[2] | - | Reported volumetric soil water content for for lower soil layer (2), irrigation fraction [V/V] | +| UZState | uz | UZ[0] | mm | Reported storage in upper groundwater zone, other fraction | +| UZForestState | uzf | UZ[1] | mm | Reported storage in upper groundwater zone, forest fraction | +| UZIrrigationState | uzi | UZ[2] | mm | Reported storage in upper groundwater zone, irrigation fraction | +| LZState | lz | LZ | mm | Reported storage in lower groundwater zone | +| ChanQState | chanq | ChanQ | m3/s | Reported istantaneous discarge at end of the model time step | +| ChanQAvgDtState *L | chanqavgdt | ChanQAvgDt | m3/s | Reported average discarge for the last routing sub-step | +| LakeLevelState *L | lakeh | LakeLevel | m | Output map(s) with lake level | +| LakePrevInflowState *L | lakeprevinq | LakeInflowOld | m3/s | Output map with lake average inflow at previous routing sub-step (ChanQ(t-1)) | +| LakePrevOutflowState *L | lakeprevoutq | LakeOutflow | m3/s | Output map with lake average outflow at previous routing sub-step (ChanQ(t-1)) | +| ReservoirFillState *R | rsfil | ReservoirFill | - | Output map(s) with Reservoir Filling [V/V] | +| CrossSection2State *SR | ch2cr | CrossSection2Area | m2 | Cross section area for split routing | +| ChSideState *SR | chside | Sideflow1Chan | m2/s | Sideflow to channel for 1st line of routing | +| PrevCmMCTState *MCT | prevcm | PrevCmMCT | - | Courant number at previous step for MCT routing | +| PrevDmMCTState *MCT | prevdm | PrevDmMCT | - | Reynolds number at previous step for MCT routing | + +*L = this state variable is required when lakes are included in the modelling domain +*R = this state variable is required when reservoirs are included in the modelling domain +*SR = this state variable is required when using the split routing module +*MCT = this state variable is required when using diffusive routing (MCT) \ No newline at end of file From 9a7f8a2d27ccaab4e6811168aa38dcba9989ed5f Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 10:23:24 +0200 Subject: [PATCH 12/70] small corrections to Annex State Variables --- docs/4_annex_state-variables/index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/4_annex_state-variables/index.md b/docs/4_annex_state-variables/index.md index e01bd022..4e112051 100644 --- a/docs/4_annex_state-variables/index.md +++ b/docs/4_annex_state-variables/index.md @@ -42,6 +42,11 @@ | PrevDmMCTState *MCT | prevdm | PrevDmMCT | - | Reynolds number at previous step for MCT routing | *L = this state variable is required when lakes are included in the modelling domain + *R = this state variable is required when reservoirs are included in the modelling domain + *SR = this state variable is required when using the split routing module -*MCT = this state variable is required when using diffusive routing (MCT) \ No newline at end of file + +*MCT = this state variable is required when using diffusive routing (MCT) + +A detailed description of OS LISFLOOD standard and optional modules is available from the [Model Documentation](https://ec-jrc.github.io/lisflood-model/) \ No newline at end of file From 7f5e35e2d68016bf3a2ca96bf33979c579318b3b Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 10:42:07 +0200 Subject: [PATCH 13/70] update Annex Parameters --- docs/4_annex_parameters/index.md | 34 ++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/docs/4_annex_parameters/index.md b/docs/4_annex_parameters/index.md index 717541ec..eacdfffc 100644 --- a/docs/4_annex_parameters/index.md +++ b/docs/4_annex_parameters/index.md @@ -3,16 +3,38 @@ | ParameterName | MinValue | MaxValue | DefaultValue | | :----------------------------- | -----------------: | -----------------: | -----------------: | | UpperZoneTimeConstant | 0.01 | 40 | 10 | -| LowerZoneTimeConstant | 40 | 1000 | 100 | +| LowerZoneTimeConstant | 40 | 730 | 100 | | GwPercValue | 0.01 | 2 | 0.8 | | LZThreshold | 0 | 30 | 10 | | b_Xinanjiang | 0.01 | 5 | 0.5 | | PowerPrefFlow | 0.5 | 8 | 4 | | SnowMeltCoef | 2.5 | 6.5 | 4 | | CalChanMan1 | 0.5 | 2 | 1 | -| CalChanMan2 | 0.5 | 5 | 1 | -| LakeMultiplier | 0.5 | 2 | 1 | +| GwLoss | 0 | 1.0 | 0 | +| CalChanMan2 *SR | 0.5 | 5 | 1 | +| CalChanMan3 *MCT | 0.5 | 5 | 1 | +| LakeMultiplier *L | 0.5 | 2 | 1 | +| ReservoirFloodStorage *R| 0.5 | 0.99 | 0.75 | +| ReservoirFloodOutflowFactor *R | 0.1 | 0.5 | 0.3 | +| QSplitMult *SR | 0 | 20 | 2 | +| TransSub *TL | 0 | 0.15 | 0 | + +*L = this parameter is required when lakes are included in the modelling domain + +*R = this parameter is required when reservoirs are included in the modelling domain + +*SR = this parameter is required when using the split routing module + +*MCT = this parameter is required when using diffusive routing (MCT) + +*TL = this parameter is required when the transmission loss module is active + +A detailed description of OS LISFLOOD standard and optional modules is available from the [Model Documentation](https://ec-jrc.github.io/lisflood-model/) + + + +*The reservoir modelling routine was updated with OS LISFLOOD v5: the updated methodology is described in [this page](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). Former versions of OS LISFLOOD code required the following parameters for reservoir modelling:* +| ParameterName | MinValue | MaxValue | DefaultValue | +| :----------------------------- | -----------------: | -----------------: | -----------------: | | adjust_Normal_Flood | 0.01 | 0.99 | 0.8 | -| ReservoirRnormqMult | 0.25 | 2 | 1 | -| QSplitMult | 0 | 20 | 2 | -| GwLoss | 0 | 0.5 | 0 | \ No newline at end of file +| ReservoirRnormqMult | 0.25 | 2 | 1 | \ No newline at end of file From 161d8c6d7cc3798526a3d0c97f95e0affd82505d Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 10:46:14 +0200 Subject: [PATCH 14/70] small changes Annex Parameters --- docs/4_annex_parameters/index.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/4_annex_parameters/index.md b/docs/4_annex_parameters/index.md index eacdfffc..b0632679 100644 --- a/docs/4_annex_parameters/index.md +++ b/docs/4_annex_parameters/index.md @@ -29,12 +29,15 @@ *TL = this parameter is required when the transmission loss module is active + A detailed description of OS LISFLOOD standard and optional modules is available from the [Model Documentation](https://ec-jrc.github.io/lisflood-model/) + + *The reservoir modelling routine was updated with OS LISFLOOD v5: the updated methodology is described in [this page](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). Former versions of OS LISFLOOD code required the following parameters for reservoir modelling:* -| ParameterName | MinValue | MaxValue | DefaultValue | +*| ParameterName | MinValue | MaxValue | DefaultValue | | :----------------------------- | -----------------: | -----------------: | -----------------: | | adjust_Normal_Flood | 0.01 | 0.99 | 0.8 | -| ReservoirRnormqMult | 0.25 | 2 | 1 | \ No newline at end of file +| ReservoirRnormqMult | 0.25 | 2 | 1 |* \ No newline at end of file From 325962230980290890437b3efe9199c506e9a980 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 10:47:23 +0200 Subject: [PATCH 15/70] small changes Annex Parameters --- docs/4_annex_parameters/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/4_annex_parameters/index.md b/docs/4_annex_parameters/index.md index b0632679..5163838f 100644 --- a/docs/4_annex_parameters/index.md +++ b/docs/4_annex_parameters/index.md @@ -37,7 +37,7 @@ A detailed description of OS LISFLOOD standard and optional modules is available *The reservoir modelling routine was updated with OS LISFLOOD v5: the updated methodology is described in [this page](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). Former versions of OS LISFLOOD code required the following parameters for reservoir modelling:* -*| ParameterName | MinValue | MaxValue | DefaultValue | +| ParameterName | MinValue | MaxValue | DefaultValue | | :----------------------------- | -----------------: | -----------------: | -----------------: | | adjust_Normal_Flood | 0.01 | 0.99 | 0.8 | -| ReservoirRnormqMult | 0.25 | 2 | 1 |* \ No newline at end of file +| ReservoirRnormqMult | 0.25 | 2 | 1 | \ No newline at end of file From 998d22b86131c93094c696057532514bfff2f224 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 11:21:06 +0200 Subject: [PATCH 16/70] Disclaimer: add how to request for help --- docs/0_disclaimer/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/0_disclaimer/index.md b/docs/0_disclaimer/index.md index 8df0913f..d13fe667 100644 --- a/docs/0_disclaimer/index.md +++ b/docs/0_disclaimer/index.md @@ -1,3 +1,5 @@ # Disclaimer -Both the program code and the LISFLOOD documentation (including the [LISFLOOD Model Documentation](https://ec-jrc.github.io/lisflood-model/), the [LISFLOOD User Guide](https://ec-jrc.github.io/lisflood-code/) and the [LISVAP documentation](https://ec-jrc.github.io/lisflood-lisvap/)) have been carefully inspected before publishing. However, no warranties, either expressed or implied, are made concerning the accuracy, completeness, reliability, usability, performance, or fitness for any particular purpose of the information contained in this documentation, to the software described in this documentation, and to other material supplied in connection therewith. The material is provided \"as is\". The entire risk as to its quality and performance is with the user. +Both the source code and the OS LISFLOOD documentation (including the [LISFLOOD Model Documentation](https://ec-jrc.github.io/lisflood-model/), the [LISFLOOD User Guide](https://ec-jrc.github.io/lisflood-code/) and the [LISVAP documentation](https://ec-jrc.github.io/lisflood-lisvap/)) have been carefully inspected before publishing. However, no warranties, either expressed or implied, are made concerning the accuracy, completeness, reliability, usability, performance, or fitness for any particular purpose of the information contained in this documentation, to the source code described in this documentation, and to other material supplied in connection therewith. The material is provided \"as is\". The entire risk as to its quality and performance is with the user. + +Users are encouraged to submit questions and/or report errors concering the Model Documentation, User Guide, source code by opening a new issue in https://github.com/ec-jrc/lisflood-code/issues From 9d9a438376e0f42dc50b5ac03e18973a10b82983 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 11:25:23 +0200 Subject: [PATCH 17/70] Disclaimer: small changes --- docs/0_disclaimer/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/0_disclaimer/index.md b/docs/0_disclaimer/index.md index d13fe667..92e7169c 100644 --- a/docs/0_disclaimer/index.md +++ b/docs/0_disclaimer/index.md @@ -2,4 +2,4 @@ Both the source code and the OS LISFLOOD documentation (including the [LISFLOOD Model Documentation](https://ec-jrc.github.io/lisflood-model/), the [LISFLOOD User Guide](https://ec-jrc.github.io/lisflood-code/) and the [LISVAP documentation](https://ec-jrc.github.io/lisflood-lisvap/)) have been carefully inspected before publishing. However, no warranties, either expressed or implied, are made concerning the accuracy, completeness, reliability, usability, performance, or fitness for any particular purpose of the information contained in this documentation, to the source code described in this documentation, and to other material supplied in connection therewith. The material is provided \"as is\". The entire risk as to its quality and performance is with the user. -Users are encouraged to submit questions and/or report errors concering the Model Documentation, User Guide, source code by opening a new issue in https://github.com/ec-jrc/lisflood-code/issues +Users are encouraged to submit questions and/or report errors concering the Documentation, User Guide, source code by opening a new issue in https://github.com/ec-jrc/lisflood-code/issues (LISFLOOD) or in https://github.com/ec-jrc/lisflood-lisvap/issues (LISVAP). From 8e19608858e29dd4bb100e7a22d1c5c9976573d8 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 11:45:31 +0200 Subject: [PATCH 18/70] Update references --- docs/0_references/index.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/0_references/index.md b/docs/0_references/index.md index f4d1afad..8c5a0e40 100644 --- a/docs/0_references/index.md +++ b/docs/0_references/index.md @@ -6,6 +6,8 @@ Anderson, 2006Anderson, E., 2006. *Snow Accumulation and Ablation Model -- SNOW- Aston, A.R., 1979. Rainfall interception by eight small trees. Journal of Hydrology 42, 383-396. +Bisselink, B., Bernhard, J., Gelati, E., Adamovic, M., Jacobs, C., Mentaschi, L., Lavalle, C. and De Roo, A., Impact of a changing climate, land use, and water usage on water resources in the Danube river basin, EUR 29228 EN, Publications Office of the European Union, Luxembourg, 2018, ISBN 978-92-79-85888-8, doi:10.2760/561327, JRC111817, https://publications.jrc.ec.europa.eu/repository/handle/JRC111817 + Bódis, K., 2009. *Development of a data set for continental hydrologic modelling*. Technical Report EUR 24087 EN JRC Catalogue number: LB-NA-24087-EN-C, Institute for Environment and Sustainability, Joint Research Centre of the European Commission Land Management and Natural Hazards Unit Action FLOOD. Input layers related to topography, channel geometry, land cover and soil characteristics of European and African river basins. Buchhorn, M., Lesiv, M., Tsendbazar, N.-E., Herold, M., Bertels, L., and Smets, B.: Copernicus Global Land Cover Layers - Collection 2. Remote Sensing 2020, 12Volume 108, 1044. doi:10.3390/rs12061044 @@ -18,16 +20,24 @@ Büttner, G., Kosztra, B., Maucha, G., Pataki, R., Kleeschulte, S., Hazeu, G., V Carneiro Freire, S., Macmanus, K., Pesaresi, M., Doxsey-Whitfield, E., and Mills, J.: Development of new open and free multi-temporal global population grids at 250 m resolution. Geospatial Data in a Changing World; Association of Geographic Information Laboratories in Europe (AGILE) (Organiser). AGILE; 2016. JRC100523 +**Choulga, M., Moschini, F., Mazzetti, C., Grimaldi, S., Disperati, J., Beck, H., Salamon, P., and Prudhomme, C.: Technical note: Surface fields for global environmental modelling, Hydrol. Earth Syst. Sci., 28, 2991–3036, https://doi.org/10.5194/hess-28-2991-2024, 2024.** + Chow, V.T., Maidment, D.R., Mays, L.M., 1988. Applied Hydrology, McGraw-Hill, Singapore, 572 pp. +De Roo, A., Bisselink, B., Guenther, S., Gelati, E. and Adamovic, M., Assessing the effects of water saving measures on Europe`s water resources, EUR 30361 EN, Publications Office of the European Union, Luxembourg, 2020, ISBN 978-92-76-21537-0, doi:10.2760/739798, JRC120388, https://publications.jrc.ec.europa.eu/repository/handle/JRC120388 + De Roo, A., Thielen, J., Gouweleeuw, B., 2003. LISFLOOD, a Distributed Water-Balance, Flood Simulation, and Flood Inundation Model, User Manual version 1.2. Internal report, Joint Research Center of the European Communities, Ispra, Italy, 74 pp. -de Sousa, L. M., Poggio, L., Batjes, N. H., Heuvelink, G. B. M., Kempen, B., Riberio, E., and Rossiter, D.: SoilGrids 2.0: producing quality-assessed soil information for the globe, SOIL Discuss. [preprint], https://doi.org/10.5194/soil-2020-65, in review, 2020. +Poggio, L., de Sousa, L. M., Batjes, N. H., Heuvelink, G. B. M., Kempen, B., Ribeiro, E., and Rossiter, D.: SoilGrids 2.0: producing soil information for the globe with quantified spatial uncertainty, SOIL, 7, 217–240, https://doi.org/10.5194/soil-7-217-2021, 2021. Fröhlich, W., 1996. Wasserstandsvorhersage mit dem Prgramm ELBA. Wasserwirtschaft Wassertechnik, ISSN: 0043-0986, Nr. 7, 1996, 34-37. +Gelati, E., Zajac, Z., Ceglar, A., Bassu, S., Bisselink, B., Adamovic, M., Bernhard, J., Malagó, A., Pastori, M., Bouraoui, F., and de Roo, A.: Assessing groundwater irrigation sustainability in the Euro-Mediterranean region with an integrated agro-hydrologic model, Adv. Sci. Res., 17, 227–253, https://doi.org/10.5194/asr-17-227-2020, 2020. + Goudriaan, J., 1977. Crop micrometeorology: a simulation study. Simulation Monographs. Pudoc, Wageningen. +Hanazaki, R., Yamazaki, D., & Yoshimura, K. (2022). Development of a reservoir flood control scheme for global flood models. Journal of Advances in Modeling Earth Systems, 14, e2021MS002944. https://doi.org/10.1029/2021MS002944 + Hock, 2003Hock, R., 2003. Temperature index melt modelling in mountain areas. *Journal of Hydrology*, 282(1-4), 104--115. Laborte, A., Gutierrez, M., Balanza, J. et al. RiceAtlas, a spatial database of global rice calendars and production. Sci Data 4, 170074 (2017). https://doi.org/10.1038/sdata.2017.74 @@ -48,6 +58,10 @@ Molnau, M., Bissell, V.C., 1983. A continuous frozen ground index for flood fore Rao, C.X. and Maurer, E.P., 1996. A simplified model for predicting daily transmission losses in a stream channel. Water Resources Bulletin, Vol. 31, No. 6., 1139-1146. +Reggiani, P., Todini, E., Meißner, D., 2014a. A conservative flow routing formulation: Déjà vu and the variable-parameter Muskingum method revisited. Journal of Hydrology, 519, 1506–1515. https://doi.org/10.1016/j.jhydrol.2014.08.057 + +Reggiani, P., Todini, E., Meißner, D., 2014b. Analytical solution of a kinematic wave approximation for channel routing. Hydrological Research, 45(1), 43–57. https://doi.org/10.2166/nh.2013.157 + Schiavina, M., Freire, S., and MacManus, K.: GHS-POP R2019A - GHS population grid multitemporal (1975-1990-2000-2015). European Commission, Joint Research Centre (JRC), 2019. [Dataset] doi:10.2905/0C6B9751-A71F-4062-830B-43C9F432370F PID: http://data.europa.eu/89h/0c6b9751-a71f-4062-830b-43c9f432370f Smets, B., Verger, A., Camacho, F., Van der Goten, R., and Jacobs, T.: Copernicus Global Land Operations ”Vegetation and Energy”: Product User Manual, Issue 1.33, 2019 [available online: https://land.copernicus.eu/global/sites/cgls.vito.be/files/products/CGLOPS1_PUM_LAI1km-V2_I1.33.pdf, last accessed: 13.05.2021.]. @@ -62,7 +76,13 @@ Supit, I., Hoojer, A.A., and Van Diepen, C.A.: System description of the Wofost Supit, I. , van der Goot, E. (eds.), 2003. Updated System Description of the WOFOST Crop Growth Simulation Model as Implemented in the Crop Growth Monitoring System Applied by the European Commission, Treemail, Heelsum, The Netherlands, 120 pp. -Todini, E., 1996. The ARNO rainfall-runoff model. Journal of Hydrology 175, 339-382. +Tang, X., Samuels, P.G., 1999. Variable parameter Muskingum-Cunge method for flood routing in a compound channel. Journal of Hydraulic Research, 37, 591–614. https://doi.org/10.1080/00221689909498519 + +Todini, E., 1996. The ARNO rainfall----runoff model. Journal of Hydrology 175, 339-382. + +Todini, E., 2007a. A mass conservative and water storage consistent variable parameter Muskingum-Cunge approach. Hydrology and Earth System Sciences, 11, 1645–1659. https://doi.org/10.5194/hess-11-1645-2007 + +Todini, E., 2007b. Corrigendum to "A mass conservative and water storage consistent variable parameter Muskingum-Cunge approach" published in Hydrology and Earth System Sciences, 11, 1645–1659. Hydrology and Earth System Sciences, 11, 1783–1783. https://doi.org/10.5194/hess-11-1783-2007 Tóth, B., Weynants, M., Nemes, A., Makó, A., Bilas, G., and Toth, G.: New generation of hydraulic pedotransfer functions for Europe. EUROPEAN JOURNAL OF SOIL SCIENCE 66 (1); 2015. p. 226-238. JRC91453 From c9112b63a7c46450a259439cd486f16f4153fed4 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 12:30:09 +0200 Subject: [PATCH 19/70] Update introduction --- docs/1_introduction_LISFLOOD/index.md | 25 +++++++++---------------- docs/1_introduction_usermanual/index.md | 11 +++++------ 2 files changed, 14 insertions(+), 22 deletions(-) diff --git a/docs/1_introduction_LISFLOOD/index.md b/docs/1_introduction_LISFLOOD/index.md index a273bfbc..75ed2c1f 100644 --- a/docs/1_introduction_LISFLOOD/index.md +++ b/docs/1_introduction_LISFLOOD/index.md @@ -1,27 +1,20 @@ ## About LISFLOOD -LISFLOOD is a spatially distributed, semi-physical hydrological rainfall-runoff model that has been developed by the Joint Research Centre (JRC) of the European Commission in late 90s. -Since then, LISFLOOD has been applied to a wide range of applications such as all kind of water resources assessments looking at e.g. -the effects of climate and land-use change as well as river regulation measures. -Its most prominent application is probably within the [European Flood Awareness System, EFAS](https://www.efas.eu/en) and the [Global Flood Awareness System, GloFAS](https://www.globalfloods.eu/) -operated under [Copernicus Emergency Management System, EMS](https://emergency.copernicus.eu/). +LISFLOOD is a spatially distributed, physically based, hydrological rainfall-runoff-routing model that has been developed by the Joint Research Centre (JRC) of the European Commission since 1997. +Since then, LISFLOOD has proven to be suitable for a variety of applications, including flood simulation and forecasting; water resources assessment; analysis of the impacts of land use changes; river regulation measures, and other water management plans; climate change analysis. +Its most prominent application is probably within the [European Flood Awareness System, EFAS](https://european-flood.emergency.copernicus.eu/react) and the [Global Flood Awareness System, GloFAS](https://global-flood.emergency.copernicus.eu/react/) +operated under [Copernicus Emergency Management System, CEMS](https://emergency.copernicus.eu/). Its wide applicability is due to its modular structure as well as its temporal and spatial flexibility. +The user to control the model inputs and outputs and the selection of the model modules. The model can be extended with additional modules when need arises, to satisfy the new target objective. -In that sense it can be extended to include anything from a better representation of a particular hydrological flow to the implementation of anthropogenic-influenced processes. At the same time the model has been designed to be applied across a wide range of spatial and temporal scales. -LISFLOOD is grid-based, and applications so far have employed grid cells of as little as 100 metres for medium-sized catchments, to 5000 metres for modelling -the whole of Europe and up to 0.1° (around 10 km) for modelling globally. Long-term water balance can be simulated (using a daily time step), -as well as individual flood events (using hourly time intervals, or even smaller). +OS LISFLOOD is grid-based, and applications so far have employed grid cells of as little as 100 metres for medium-sized catchments, and up kilometer scale for continental and global applications. +OS LISFLOOD can be used to generate long-term water balance simulations (climatology runs, with hourly to daily time steps), as well as individual flood events (with hourly to daily time steps). Although LISFLOOD's primary output product is channel discharge, all internal rate and state variables (soil moisture, for example) can be written as output as well. - All output can be written as grids, or time series at user-defined points or areas. - The user has complete control over how output is written, thus minimising any waste of disk space or CPU time. - -LISFLOOD is implemented in Python and PCRaster Model Framework, wrapped in a Python based interface. - -The Python wrapper of LISFLOOD enables the user to control the model inputs and outputs and the selection of the model modules. -LISFLOOD runs on any operating system for which Python and PCRaster are available. +All output can be written as grids, or time series at user-defined points or areas. The user has complete control over how output is written, thus minimising any waste of disk space or CPU time. +LISFLOOD is implemented in Python high level language: requirements and installation guidelines are described in [this page](https://github.com/ec-jrc/lisflood-code#lisflood-os). [🔝](#top) diff --git a/docs/1_introduction_usermanual/index.md b/docs/1_introduction_usermanual/index.md index 6bd74282..930a33d1 100644 --- a/docs/1_introduction_usermanual/index.md +++ b/docs/1_introduction_usermanual/index.md @@ -8,13 +8,12 @@ In order to apply this knowledge into practice, we provide two fully implemented Note, this document is **not a LISFLOOD model documentation**. The [lisflood-model official documentation](https://ec-jrc.github.io/lisflood-model/) contains the most up-to-date and complete technical documentation of the LISFLOOD model. This includes all the concepts and model equations of all the standard LISFLOOD processes, but also all the optional modules. -Lastly, we also share with you two other tools: +OS LISFLOOD users might also be interested in the following complemetary open-source repositories: -* LISVAP, our tool to calculate the evapotranspiration and -* our calibration tool that we've developed. +* [LISVAP](https://github.com/ec-jrc/lisflood-lisvap) allows the computation of reference evapotrasnpiration gridded dataset. The relevant documentation can be found at [LISVAP documentation](https://ec-jrc.github.io/lisflood-lisvap/) +* [OS LISFLOOD calibration tool](https://github.com/ec-jrc/lisflood-calibration) enables model parameter documentation. The relevant documentation is available at [Calibration Tool documentation](https://ec-jrc.github.io/lisflood-calibration/). +* [OS LISFLOOD utilities](https://github.com/ec-jrc/lisflood-utilities) support the preparation of model inputs, the post-processing and comparison of model outputs. The relevant documentation is provided in the [lisflood-utilities repository](https://github.com/ec-jrc/lisflood-utilities#lisflood-utilities). +* [pyg2p](https://github.com/ec-jrc/pyg2p) allows re-gridding and interpolation of meteorological files in GRIB format to nectdf (and pcraster) format. The relevant documentation is provided in the [pyg2p repositrory](https://github.com/ec-jrc/pyg2p#pyg2p) -LISVAP Source code is on LISVAP [GitHub repository](https://github.com/ec-jrc/lisflood-lisvap) while its documentation can be found at [LISVAP GitHub pages](https://ec-jrc.github.io/lisflood-lisvap/). - -Calibration tool source code is on his dedicated [repository](https://github.com/ec-jrc/lisflood-calibration) while documentation is at [Calibration Tool GitHub Pages](https://ec-jrc.github.io/lisflood-calibration/). [🔝](#top) From de1f2838a1ec1fcac4c22ced0c305bc418d261da Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 15:46:32 +0200 Subject: [PATCH 20/70] Update description channel geometry maps based on errors and inaccuracies reported by users --- docs/4_Static-Maps_channel-geometry/index.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md index f8588a2c..763e3fac 100644 --- a/docs/4_Static-Maps_channel-geometry/index.md +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -77,28 +77,39 @@ $changrad$ is set equal 0 where $ldd$ is 5. The Manning's roughness coefficient for channels can be derived by an empirical relationship between the elevation (in $m$) of the grid-cell and its upstream area (in $km^2$) following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf): $ chanman =$
-$ 0.025 + 0.015 \cdot \min(\frac{50}{upstreamArea} , 1) + 0.30 \cdot \min(\frac{elevation}{2000} , 1) $ +$ 0.025 + 0.015 \cdot \min(\frac{50}{upstreamArea} , 1) + 0.030 \cdot \min(\frac{elevation}{2000} , 1) $ ### Bottom width (chanbw) The channel bottom width map can be computed using empirical relationship that relate channel width of the grid-cell with its upstream area (in $km^2$); for example, following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
$ chanbw = 0.0032 \cdot upstreamArea $ +It is here noted that the study mentioned above ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)), also suggests a second step. The LISFLOOD model first needs to be run for the entire simulation period length with the initial channel bottom width to get a long-term average discharge ($avgdis$) which is then used in the following *empirical* equation:
+ +$ chanbw_step2 = avgdis^0.539 $ + +The latter empirical equation stems from a study on the European domain ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)). +It is not possible to identify an optimal solution for all the catchments, and all the applications. Users are advised to test the one or two-steps protocol for their specific scenario and identify the best solution according to their expert judgement. +For example, chanbw used for the Copernicus Emergency Management Service European and Global Flood Awareness System ([CEMS EFAS](https://european-flood.emergency.copernicus.eu/react) and [CEMS GloFAS](https://global-flood.emergency.copernicus.eu/react)) operational set-ups were computed based on the first step only. + + ### Floodplain width (Wfp) The floodplain width (in $m$) can be computed using the following equation from [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
$ floodplainWidth = 3 \cdot chanbw $ ### Bankfull channel depth (chanbnkf) -The channel bankfull depth can be computed in two steps. The first step uses the empirical relationship relating the channel bankfull depth of the grid-cell with its upstream area (in $km^2$) following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
+Channel bankfull depth can be computed in two steps. The first step uses the empirical relationship relating the channel bankfull depth of the grid-cell with its upstream area (in $km^2$) following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
$ chanbnkf_{step1} = 0.27 \cdot upstreamArea^{0.33} $ -The second step uses the Manning's equation following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf). The LISFLOOD model first needs to be run for the calibration period length with the initial channel bottom width and bankfull depth parameters to get a long-term average discharge ($avgdis$) which is then used in the Manning's equation:
+The second (optional) step uses the Manning's equation following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf). The LISFLOOD model first needs to be run for the entire simulation period length with the initial channel bottom width and bankfull depth parameters to get a long-term average discharge ($avgdis$) which is then used in the Manning's equation:
$ chanbnkf_{step2} =$
$ 1.004 \cdot chanman^{0.6} \cdot (2 \cdot avgdis)^{0.6} \cdot chanbw^{-0.6} \cdot changrad^{-0.3} $ +It is not possible to identify an optimal solution for all the catchments, and all the applications. Users are advised to test the one or two-steps protocol for their specific scenario and identify the best solution according to their expert judgement. +For example, chanbnkf used for the Copernicus Emergency Management Service European and Global Flood Awareness System ([CEMS EFAS](https://european-flood.emergency.copernicus.eu/react) and [CEMS GloFAS](https://global-flood.emergency.copernicus.eu/react)) operational set-ups were computed based on the first step only. ## Results (examples) From dc8fba96d7533a88cc5ce88dfcbc3a23ac6d4ed8 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 15:51:07 +0200 Subject: [PATCH 21/70] small fixes 4_Static-Maps_channel-geometry --- docs/4_Static-Maps_channel-geometry/index.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md index 763e3fac..adba8786 100644 --- a/docs/4_Static-Maps_channel-geometry/index.md +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -65,28 +65,28 @@ The channel length map (in meters) can be created by using the 'rivlen' layers f ### Channel gradient (changrad) To compute the channel gradient map, the absolute difference (in meters) of the elevation between two grid-cells is first calculated by using i) the local drain direction (ldd) map to extract the connectivity between grid-cells, and ii) the channel length of the upstream grid-cell:
-$ \small elevationDifference = elevationUpstreamCell-elevationDownstreamCell $ +$\small elevationDifference = elevationUpstreamCell-elevationDownstreamCell$ Then, the channel gradient is computed and assigned to the upstream grid-cell: -$ changrad=\frac{elevationDifference}{chanlength} $ +$changrad=\frac{elevationDifference}{chanlength}$ $changrad$ is set equal 0 where $ldd$ is 5. ### Manning's roughness coefficient (chanman) The Manning's roughness coefficient for channels can be derived by an empirical relationship between the elevation (in $m$) of the grid-cell and its upstream area (in $km^2$) following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf): -$ chanman =$
-$ 0.025 + 0.015 \cdot \min(\frac{50}{upstreamArea} , 1) + 0.030 \cdot \min(\frac{elevation}{2000} , 1) $ +$chanman =$
+$0.025 + 0.015 \cdot \min(\frac{50}{upstreamArea} , 1) + 0.030 \cdot \min(\frac{elevation}{2000} , 1)$ ### Bottom width (chanbw) The channel bottom width map can be computed using empirical relationship that relate channel width of the grid-cell with its upstream area (in $km^2$); for example, following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
-$ chanbw = 0.0032 \cdot upstreamArea $ +$chanbw = 0.0032 \cdot upstreamArea$ It is here noted that the study mentioned above ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)), also suggests a second step. The LISFLOOD model first needs to be run for the entire simulation period length with the initial channel bottom width to get a long-term average discharge ($avgdis$) which is then used in the following *empirical* equation:
-$ chanbw_step2 = avgdis^0.539 $ +$chanbw_step2 = avgdis^0.539$ The latter empirical equation stems from a study on the European domain ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)). It is not possible to identify an optimal solution for all the catchments, and all the applications. Users are advised to test the one or two-steps protocol for their specific scenario and identify the best solution according to their expert judgement. @@ -96,17 +96,17 @@ For example, chanbw used for the Copernicus Emergency Management Service Europea ### Floodplain width (Wfp) The floodplain width (in $m$) can be computed using the following equation from [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
-$ floodplainWidth = 3 \cdot chanbw $ +$floodplainWidth = 3 \cdot chanbw$ ### Bankfull channel depth (chanbnkf) Channel bankfull depth can be computed in two steps. The first step uses the empirical relationship relating the channel bankfull depth of the grid-cell with its upstream area (in $km^2$) following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
-$ chanbnkf_{step1} = 0.27 \cdot upstreamArea^{0.33} $ +$chanbnkf_{step1} = 0.27 \cdot upstreamArea^{0.33}$ The second (optional) step uses the Manning's equation following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf). The LISFLOOD model first needs to be run for the entire simulation period length with the initial channel bottom width and bankfull depth parameters to get a long-term average discharge ($avgdis$) which is then used in the Manning's equation:
-$ chanbnkf_{step2} =$
-$ 1.004 \cdot chanman^{0.6} \cdot (2 \cdot avgdis)^{0.6} \cdot chanbw^{-0.6} \cdot changrad^{-0.3} $ +$chanbnkf_{step2} =$
+$1.004 \cdot chanman^{0.6} \cdot (2 \cdot avgdis)^{0.6} \cdot chanbw^{-0.6} \cdot changrad^{-0.3}$ It is not possible to identify an optimal solution for all the catchments, and all the applications. Users are advised to test the one or two-steps protocol for their specific scenario and identify the best solution according to their expert judgement. For example, chanbnkf used for the Copernicus Emergency Management Service European and Global Flood Awareness System ([CEMS EFAS](https://european-flood.emergency.copernicus.eu/react) and [CEMS GloFAS](https://global-flood.emergency.copernicus.eu/react)) operational set-ups were computed based on the first step only. From 9ed0d69873b6e3bd8ac0db8482c84286c29c6b27 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 15:55:58 +0200 Subject: [PATCH 22/70] small fixes 4_Static-Maps_channel-geometry --- docs/4_Static-Maps_channel-geometry/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md index adba8786..a0174190 100644 --- a/docs/4_Static-Maps_channel-geometry/index.md +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -48,7 +48,7 @@ Channel characteristics, explained above, are shown in the Figure 41 below.
-$chanbw = 0.0032 \cdot upstreamArea$ +$chanbw_{step1} = 0.0032 \cdot upstreamArea$ It is here noted that the study mentioned above ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)), also suggests a second step. The LISFLOOD model first needs to be run for the entire simulation period length with the initial channel bottom width to get a long-term average discharge ($avgdis$) which is then used in the following *empirical* equation:
-$chanbw_step2 = avgdis^0.539$ +$chanbw_{step2} = avgdis^{0.539}$ The latter empirical equation stems from a study on the European domain ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)). It is not possible to identify an optimal solution for all the catchments, and all the applications. Users are advised to test the one or two-steps protocol for their specific scenario and identify the best solution according to their expert judgement. From 2dfa2e733156f5aeba7d9f463e8639b377370eeb Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 16:00:37 +0200 Subject: [PATCH 23/70] small fixes 4_annex_tests --- docs/4_annex_tests/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/4_annex_tests/index.md b/docs/4_annex_tests/index.md index a0aaed0d..93552870 100644 --- a/docs/4_annex_tests/index.md +++ b/docs/4_annex_tests/index.md @@ -809,7 +809,7 @@ These tests perform short and long (max 1 year) execution of OSlisflood on the P ## Release test for EFAS and GloFAS At each release, in addition to pass all tests described above, OSLisflood is tested also with full domains of EFAS and GLOFAS. -These tests are executed by internal OSLisflood developers when hydrological model is not changed. +These tests are executed by internal OSLisflood developers. [🔝](#top) From c1a4715fd3cd957f26a8ed19431c8d93bd6c794d Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 16:07:16 +0200 Subject: [PATCH 24/70] correct typos --- docs/1_introduction_LISFLOOD/index.md | 2 +- docs/4_annex_tests/index.md | 42 +++++++++++++-------------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/1_introduction_LISFLOOD/index.md b/docs/1_introduction_LISFLOOD/index.md index 75ed2c1f..d4baaa9c 100644 --- a/docs/1_introduction_LISFLOOD/index.md +++ b/docs/1_introduction_LISFLOOD/index.md @@ -15,6 +15,6 @@ OS LISFLOOD can be used to generate long-term water balance simulations (climato Although LISFLOOD's primary output product is channel discharge, all internal rate and state variables (soil moisture, for example) can be written as output as well. All output can be written as grids, or time series at user-defined points or areas. The user has complete control over how output is written, thus minimising any waste of disk space or CPU time. -LISFLOOD is implemented in Python high level language: requirements and installation guidelines are described in [this page](https://github.com/ec-jrc/lisflood-code#lisflood-os). +LISFLOOD is implemented in Python high level language: the users are recommented to refer to the chapter [Installation of the LISFLOOD model](3_step2_installation/index.md) and to the readme of the [OS LISFLOOD GitHub repository](https://github.com/ec-jrc/lisflood-code#lisflood-os) to find detailed information on requirements and installation protocol. [🔝](#top) diff --git a/docs/4_annex_tests/index.md b/docs/4_annex_tests/index.md index 93552870..e8c0cbcc 100644 --- a/docs/4_annex_tests/index.md +++ b/docs/4_annex_tests/index.md @@ -4,7 +4,7 @@ In this document we report details about all kind of tests we execute during dev ## Introduction -In [tests/](https://github.com/ec-jrc/lisflood-code/tree/master/tests){:target="_blank"} folder of lisflood-code repository there are several unit +In [tests/](https://github.com/ec-jrc/lisflood-code/tree/master/tests) folder of lisflood-code repository there are several unit tests ensuring that all *helper components* of Lisflood work as expected. These components are not strictly related to the hydrological model but are essential for the execution. @@ -21,13 +21,13 @@ See the dedicated paragraph on this page for more details. Static data and fixtures (i.e. static maps and meteo forcings) comes from two catchments. They are netCDF files reduced in space (Po catchment area) and time (6 hourly data from 2015-12-10 12:00 to 2017-12-29 12:00) from original EFAS dataset. -In tests where values comparison are needed, we use [lisfloodutilities.compare](https://github.com/ec-jrc/lisflood-utilities/blob/master/src/lisfloodutilities/compare/__init__.py){:target="_blank"} +In tests where values comparison are needed, we use [lisfloodutilities.compare](https://github.com/ec-jrc/lisflood-utilities/blob/master/src/lisfloodutilities/compare/__init__.py) helper classes (NetCDFComparator, TSSComparator). These classes compare netCDF and TSSs values between two dataset of OSLisflood results, using `atol=0.0001` and `rtol=0.001` (defaults values in NetCDFComparator and TSSComparator). -See [`numpy.allclose`](https://numpy.org/doc/stable/reference/generated/numpy.allclose.html){:target="_blank"} for more details. +See [`numpy.allclose`](https://numpy.org/doc/stable/reference/generated/numpy.allclose.html) for more details. -Some tests use `array_equal` option in order to compare values using [`numpy.array_equal`](https://numpy.org/doc/stable/reference/generated/numpy.array_equal.html){:target="_blank"} function. +Some tests use `array_equal` option in order to compare values using [`numpy.array_equal`](https://numpy.org/doc/stable/reference/generated/numpy.array_equal.html) function. Tests that are using Comparator classes are: @@ -214,7 +214,7 @@ The following table summarize the matrix of combinations of options we test: #### Implementation -[test_options.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_options.py){:target="_blank"} +[test_options.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_options.py) We define a test for each combination from the table above then we check that a particular function inside the module is called with expected arguments. We use a mocked `loadmap` function (the function that LF uses to load netCDF or PCRaster maps) and check that it's called/not called as expected by the module under test. @@ -243,7 +243,7 @@ Make sure that OSLisflood prints state maps and end maps. Last step in state map #### Implementation -[test_state_end_maps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_state_end_maps.py){:target="_blank"} +[test_state_end_maps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_state_end_maps.py) |Test case | Expected | @@ -273,7 +273,7 @@ In LF, you activate/deactivate report maps/tss options by setting 1/0 in *lfopti | repWIndex | #### Implementation -[test_reported_maps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_maps.py){:target="_blank"} +[test_reported_maps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_maps.py) In order to test that a specific map is written when a report map option is activated, we mock the ```lisflood.global_modules.output.writenet``` (the function LF uses to write netCDF maps) and assert that @@ -302,7 +302,7 @@ Make sure that OSLisflood prints TSS files when reporting options are active. | repMeteoUpsGauges | #### Implementation -[test_reported_tss.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_tss.py){:target="_blank"} +[test_reported_tss.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_tss.py) In order to test that a specific TSS is written when a report tss option is activated, we mock the ```lisflood.global_modules.output.TimeoutputTimeseries``` (the PCRaster framework class that LF uses to write TSS files) @@ -324,7 +324,7 @@ def test_rep_dischargetss(self): Make sure that OSLisflood prints state files following reporting steps formula in ReportSteps xml option. #### Implementation -[test_reported_steps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_steps.py){:target="_blank"} +[test_reported_steps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_steps.py) In order to test that specific files are written when a step matches the ReportSteps formula, we use a test formula 'starttime+10..endtime'. Then we geterate specific outputs for the desired steps and compare the two output using NetCDFComparator(array_equal=True) @@ -370,7 +370,7 @@ Then we geterate specific outputs for the desired steps and compare the two outp Make sure OSLisflood can run an initial run to generate AVGDIS and LZAVIN maps with proper extension (.nc or .map) #### Implementation -[test_reported_maps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_maps.py){:target="_blank"} +[test_reported_maps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_reported_maps.py) Test asserts that writenet was called with 'AvgDis' and 'LZAvInflowMap' arguments (LF variables for avgdis.nc and lzavin.nc files) and with the correct filename. @@ -390,7 +390,7 @@ We need to ensure that either using dates or integers for StepStart and StepEnd Tests are done with daily and 6-hourly timesteps (i.e. DtSec=86400 and DtSec=21600). #### Implementation -[test_dates_steps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_dates_steps.py){:target="_blank"} +[test_dates_steps.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_dates_steps.py) Execute lisflood with report options activated, using dates formats for StepStart and StepEnd and a daily timestep. Then execute lisflood with same setup, this time using integers for StepStart and StepEnd. @@ -439,7 +439,7 @@ UseWaterDemandAveYear = this option allows to read water demand information from For more information please refer to [Water use - LISFLOOD (ec-jrc.github.io)](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) #### Implementation -[test_water_abstraction.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_water_abstraction.py){:target="_blank"} +[test_water_abstraction.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_water_abstraction.py) The test uses two datasets: waterdemand19902019, that includes daily data from 1990 to 2019, and waterdemand, that includes only one year used as reference for any year. Test asserts that output generated using TransientWaterDemandChange with useWaterDemandAveYear flag active using the reference dataset included into the waterdemand folder is the same of the one generated disabling useWaterDemandAveYear flag and using the waterdemand19902019 folder. @@ -472,13 +472,13 @@ Test asserts that output generated using TransientWaterDemandChange with useWate ## Other LF tests included in repository -There are other tests included in [tests/](https://github.com/ec-jrc/lisflood-code/tree/master/tests){:target="_blank"}. +There are other tests included in [tests/](https://github.com/ec-jrc/lisflood-code/tree/master/tests). folder of repository that can't be defined as unit tests. These tests execute the development version of lisflood with some predefined XML settings, and asserts that results are equal to a reference dataset (test oracle data in black-box terminology). -In order to reduce dataset size, we use a test catchment (same as [LF_ETRS89_UseCase](https://github.com/ec-jrc/lisflood-usecases/tree/master/LF_ETRS89_UseCase){:target="_blank"}) +In order to reduce dataset size, we use a test catchment (same as [LF_ETRS89_UseCase](https://github.com/ec-jrc/lisflood-usecases/tree/master/LF_ETRS89_UseCase)) with static data clipped from EFAS domain. Meteo netCDF forcings are also cut from domain and contain 6 hourly data from 2015-12-10 12:00 to 2017-12-29 12:00. **Note:** These tests fail when hydrological model is changed between reference version and current version under test. @@ -502,7 +502,7 @@ All test cases are executed with following modules activated: #### Implementation -[test_results.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_results.py){:target="_blank"} +[test_results.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_results.py) |Test case | DtSec | Simulation period | Expected | @@ -546,7 +546,7 @@ All test cases are executed with following modules activated: **Note:** This test doesn't use a reference dataset so it's not a black-box test. It ensures that cold and warm runs are equivalent. #### Implementation -[test_warmstart.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_warmstart.py){:target="_blank"} +[test_warmstart.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_warmstart.py) To illustrate implementation of this test we take test_warmstart_daily as example. test_warmstart_6h is similar but with a shorter simulation period and DtSec=21600. 1. Execute an initialization run for year 2000 and save avgdis.nc and lzavin.nc outputs in a folder. @@ -656,7 +656,7 @@ This test demonstrates that wateruse module introduces incongruities between run #### Implementation -[test_subcatchments.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_subcatchments.py){:target="_blank"} +[test_subcatchments.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_subcatchments.py) ```python settings_files = { @@ -734,7 +734,7 @@ This test verifies the correct functioning of the option inflow. Uses a catchmen #### Implementation -[test_inflow.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_inflow.py){:target="_blank"} +[test_inflow.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_inflow.py) |Test case | DtSec | Simulation period | Expected | @@ -748,7 +748,7 @@ Verifies the correct functioning of the code for projected and geographic coordi #### Implementation -[test_latlon.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_latlon.py){:target="_blank"} +[test_latlon.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_latlon.py) |Test case | DtSec | Simulation period | Expected | @@ -763,7 +763,7 @@ Verifies the use of cached files. It compares the output generated and the numbe #### Implementation -[test_caching.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_caching.py){:target="_blank"} +[test_caching.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_caching.py) |Test case | DtSec | Simulation period | Expected | @@ -777,7 +777,7 @@ Verifies chunking files using NetCDFTimeChunks with values `1`, `10`, `auto` and #### Implementation -[test_chunking.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_chunking.py){:target="_blank"} +[test_chunking.py](https://github.com/ec-jrc/lisflood-code/blob/master/tests/test_chunking.py) |Test case | DtSec | Simulation period | Expected | From 4fc4349df9da5a8d9eb061fbd9f5c15661bbefdb Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 17:53:09 +0200 Subject: [PATCH 25/70] specify 0,1 values in domain map --- docs/4_Static-Maps_general-maps/index.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/4_Static-Maps_general-maps/index.md b/docs/4_Static-Maps_general-maps/index.md index 3fc703d0..46f2c7b6 100644 --- a/docs/4_Static-Maps_general-maps/index.md +++ b/docs/4_Static-Maps_general-maps/index.md @@ -1,20 +1,20 @@ # General maps -+ **Area mask & land use mask maps.**
++ **Domain mask & land use mask maps.**
The mask maps in the hydrological model are used to detect where model should perform computations and where it shouldn't (skip the grid-cell). Area and land use masks are both Boolean maps which define model boundaries and land use calculation domain respectively.
+ **Grid-cell length & grid-cell area maps.**
The grid-cell length and grid-cell area maps are used in LISFLOOD model to accurately compute the areal sums over grid-cells (e.g. the upstream area of the river when areas of all connected grid-cells are summed together or the rainfall amount over a certain grid-cell). If projection properties are in meters these maps become optional.
-## Area mask and land use mask maps +## Domain mask and land use mask maps ### General map information and possible source data | Map name | File name;type | Units; range | Description | | :---| :--- | :--- | :--- | -| Mask map| area.nc;
Type: Float32 | Units: -;
Range: NoData or 1 | Boolean map that defines model boundaries| -| Land use mask| landuse.nc;
Type: Float32 | Units: -;
Range: NoData or 1 | Boolean map for land use calculations | +| Mask map| domain.nc;
Type: Boolean | Units: -;
Range: 0 or 1 | Boolean map that defines model boundaries| +| Land use mask| landuse.nc;
Type: Float32 | Units: -;
Range: NoData or 1 | Boolean map for land use calculations, this map is used ony in the module indicatorcalc.py | | Source data| Reference/preparation | Temporal coverage | Spatial information | | :---| :--- | :--- | :--- | @@ -22,8 +22,9 @@ The grid-cell length and grid-cell area maps are used in LISFLOOD model to accur ### Methodology -To create a mask field (mask map or land use mask), source data (e.g. elevation or flow direction) values are changed to ‘1’ and the variable type is forced to be Byte for the mask map (area.nc), and Float32 for the land use mask (lusemask.nc).
-If the source data is at a higher resolution and/or is larger than the required model domain, it needs to be re-scaled to the required grid-cell resolution and/or clipped to the required model domain.
+To create a mask field (mask map or land use mask), source data (e.g. elevation or flow direction) values are changed to ‘1’ and the variable type is forced to be Byte for the mask map (domain.nc), and Float32 for the land use mask (lusemask.nc).
+To reiterate, the domain map must have 1 value were LISFLOOD computations are expected, 0 value in pixels that must be excluded from LISFLOOD computations.
+ ### Results (examples) From d077cd6ebef3dc64214f5f2cf83ecbe748a33d05 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 17:55:56 +0200 Subject: [PATCH 26/70] specify 0,1 values in domain map --- docs/4_Static-Maps_general-maps/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/4_Static-Maps_general-maps/index.md b/docs/4_Static-Maps_general-maps/index.md index 46f2c7b6..6f5c0eef 100644 --- a/docs/4_Static-Maps_general-maps/index.md +++ b/docs/4_Static-Maps_general-maps/index.md @@ -1,7 +1,7 @@ # General maps -+ **Domain mask & land use mask maps.**
-The mask maps in the hydrological model are used to detect where model should perform computations and where it shouldn't (skip the grid-cell). Area and land use masks are both Boolean maps which define model boundaries and land use calculation domain respectively.
++ **Domain (or area) mask & land use mask maps.**
+The mask maps in the hydrological model are used to detect where model should perform computations and where it shouldn't (skip the grid-cell). Domain (or area) and land use masks are both Boolean maps which define model boundaries and land use calculation domain respectively.
+ **Grid-cell length & grid-cell area maps.**
The grid-cell length and grid-cell area maps are used in LISFLOOD model to accurately compute the areal sums over grid-cells (e.g. the upstream area of the river when areas of all connected grid-cells are summed together or the rainfall amount over a certain grid-cell). If projection properties are in meters these maps become optional.
@@ -35,7 +35,7 @@ To reiterate, the domain map must have 1 value were LISFLOOD computations are ex

-*Figure 1: Mask map at 1 arc min horizontal resolution for European domain (left) and at 3 arc min horizontal resolution for Global domain (right) with coloured areas showing land pixel.* +*Figure 1: Domain (or area) mask map at 1 arc min horizontal resolution for European domain (left) and at 3 arc min horizontal resolution for Global domain (right) with coloured areas showing land pixel.* From 24fc6fd5276528e605b66cfea1a0f8859832d50a Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Tue, 28 Apr 2026 18:05:49 +0200 Subject: [PATCH 27/70] add info lddrepair, lddmask --- docs/4_Static-Maps_topography/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/4_Static-Maps_topography/index.md b/docs/4_Static-Maps_topography/index.md index 95aeb5b7..391ddfae 100644 --- a/docs/4_Static-Maps_topography/index.md +++ b/docs/4_Static-Maps_topography/index.md @@ -26,7 +26,8 @@ The upstream area in a distributed hydrological model is the accumulated area of It is suggested to use cautiously any file transforming commands as they might change file structure. Here it is suggested to use only CDO, GDAL and Python commands to preserve initial file structure as much as possible (especially latitude and longitude values) and be able to use it later as a Template for all other static maps.
To create a local drain direction (ldd) field from a flow direction map, initial file values in a NetCDF format are changed in the following way for different geographical directions. Mouth: ‘-1’=>’5’, Inland: ‘0’=>’5’, North: ‘1’=>’8’, NE: ‘2’=>’9’, East: ‘3’=>’6’, SE: ‘4’=>’3’, South: ‘5’=>’2’, SW: ‘6’=>’1’, West: ‘7’=>’4’, NW: ‘8’=>’7’.
-Note: Obtaining a flow direction map from a digital elevation model is a complex process and is not described here. A good example of how to create a flow direction map can be found in [Yamazaki et al. (WRR, 2019)](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2019WR024873). Note also that the created ldd file must be checked and corrected if needed, so that water is not flowing out of the region of interest. Finally, after all manipulations of the NetCDF file, latitude and longitude values from the native files must be copied to the newly generated file to insure identical structure of all static map files.
+Note: Obtaining a flow direction map from a digital elevation model is a complex process and is not described here. A good example of how to create a flow direction map can be found in [Yamazaki et al. (WRR, 2019)](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2019WR024873). Note also that the created ldd file must be checked and corrected if needed, so that water is not flowing out of the region of interest. These pages provide relevant information on the definition and preparation of a sound ldd: [lddrepair](https://pcraster.geo.uu.nl/pcraster/4.4.2/documentation/pcraster_manual/sphinx/op_lddrepair.html) and [lddmask](https://pcraster.geo.uu.nl/pcraster/4.4.2/documentation/pcraster_manual/sphinx/op_lddmask.html_). Expert users might want to check the usage of lddmask witih the OS LISFLOOD module [routing.py](https://github.com/ec-jrc/lisflood-code/blob/master/src/lisflood/hydrological_modules/routing.py). +Finally, after all manipulations of the NetCDF file, latitude and longitude values from the native files must be copied to the newly generated file to insure identical structure of all static map files.
### Results (example) From 13236918a770e7af65aabcfc6aa00c6758c3f793 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 29 Apr 2026 10:44:10 +0200 Subject: [PATCH 28/70] udpate description chanbw EFAS and GloFAS maps, based on Choulga et al.2024 --- docs/4_Static-Maps_channel-geometry/index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md index a0174190..256de094 100644 --- a/docs/4_Static-Maps_channel-geometry/index.md +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -60,7 +60,7 @@ The channel side slope map is calculated by dividing the horizontal distance (re *Figure 42: Zoom of Figure 41 with highlighted components dx and dy (in red) used to calculate the channel side slope (original figure is from [Burek et al., 2013](https://publications.jrc.ec.europa.eu/repository/handle/JRC78917)).* ### Channel length (chanlenght) -The channel length map (in meters) can be created by using the 'rivlen' layers from the CaMa-Flood dataset (for more information see the FLOW method of Yamazaki, link), multiplied by the LISFLOOD model mask. +The channel length map (in meters) can be created by using the 'rivlen' layers from the Catchment-based Macro-scale Floodplain Global River Hydrodynamics Model v4.0 maps ([CaMa-Flood](https://global-hydrodynamics.github.io/CaMa-Flood/); [Yamazaki et al, 2011](https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2010WR009726)), multiplied by the LISFLOOD model mask. ### Channel gradient (changrad) To compute the channel gradient map, the absolute difference (in meters) of the elevation between two grid-cells is first calculated by using i) the local drain direction (ldd) map to extract the connectivity between grid-cells, and ii) the channel length of the upstream grid-cell:
@@ -90,7 +90,9 @@ $chanbw_{step2} = avgdis^{0.539}$ The latter empirical equation stems from a study on the European domain ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)). It is not possible to identify an optimal solution for all the catchments, and all the applications. Users are advised to test the one or two-steps protocol for their specific scenario and identify the best solution according to their expert judgement. -For example, chanbw used for the Copernicus Emergency Management Service European and Global Flood Awareness System ([CEMS EFAS](https://european-flood.emergency.copernicus.eu/react) and [CEMS GloFAS](https://global-flood.emergency.copernicus.eu/react)) operational set-ups were computed based on the first step only. + +It is here noted that chanbw used for the Copernicus Emergency Management Service European and Global Flood Awareness System ([CEMS EFAS](https://european-flood.emergency.copernicus.eu/react) and [CEMS GloFAS](https://global-flood.emergency.copernicus.eu/react)) operational set-ups were computed using a slightly different protocol: *width* values from the ([CaMa-Flood](https://global-hydrodynamics.github.io/CaMa-Flood/)) were used as primary source of data. Where the processing of such primary source of data led to negative values, *chanbw* was computed using step1 of the protocol explained in this page. +More details on the workflow used to derive CEMS EFAS and GloFAS *chanbw* maps are provided in [Choulga et al., 2024](https://hess.copernicus.org/articles/28/2991/2024/). ### Floodplain width (Wfp) From dd0bcbbffb9198501730bf5b2fbd8c9c96a86886 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 29 Apr 2026 10:48:15 +0200 Subject: [PATCH 29/70] correct broken links --- docs/4_Static-Maps_channel-geometry/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md index 256de094..c2609a66 100644 --- a/docs/4_Static-Maps_channel-geometry/index.md +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -35,9 +35,9 @@ Channel characteristics, explained above, are shown in the Figure 41 below.
Date: Wed, 29 Apr 2026 10:55:50 +0200 Subject: [PATCH 30/70] clarify channel mask map definition in LISFLOOD --- docs/4_Static-Maps_channel-geometry/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md index c2609a66..a3f0a48c 100644 --- a/docs/4_Static-Maps_channel-geometry/index.md +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -45,7 +45,7 @@ Channel characteristics, explained above, are shown in the Figure 41 below.
Date: Wed, 29 Apr 2026 11:08:54 +0200 Subject: [PATCH 31/70] clarify chanbw --- docs/4_Static-Maps_channel-geometry/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/4_Static-Maps_channel-geometry/index.md b/docs/4_Static-Maps_channel-geometry/index.md index a3f0a48c..309ae74c 100644 --- a/docs/4_Static-Maps_channel-geometry/index.md +++ b/docs/4_Static-Maps_channel-geometry/index.md @@ -29,7 +29,7 @@ Channel characteristics, explained above, are shown in the Figure 41 below.
Type: Float32 | Units: m;
Range>0 |Channel length (value can exceed grid size, to account for meandering rivers)| |Channel gradient |changrad.nc;
Type: Float32 |Units: m/m;
Range: [0-1] |Channel longitudinal gradient| |Manning's roughness coefficient |chanman.nc;
Type: Float32 |Units: m1/3 s-1 |channels Manning's roughness coefficient | -|Bottom width |chanbw.nc;
Type: Float32 |Units: m;
Range>0 |Channel bottom width| +|Bottom width |chanbw.nc;
Type: Float32 |Units: m;
Range>=0 |Channel bottom width| |Floodplain |chanflpn.nc;
Type: Float32 |Units: m;
Range>0 |Width of the area where the surplus of water is distributed when the water level in the channel exceeds the bankfull channel depth |Bankfull channel depth |chanbnkf.nc;
Type: Float32 |Units: m;
Range>0 |Bankfull channel depth @@ -80,11 +80,12 @@ $chanman =$
$0.025 + 0.015 \cdot \min(\frac{50}{upstreamArea} , 1) + 0.030 \cdot \min(\frac{elevation}{2000} , 1)$ ### Bottom width (chanbw) -The channel bottom width map can be computed using empirical relationship that relate channel width of the grid-cell with its upstream area (in $km^2$); for example, following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
+The channel bottom width map can be computed using empirical relationship that relate channel width of the grid-cell with its upstream area (in $km^2$). +For example, following [Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf):
$chanbw_{step1} = 0.0032 \cdot upstreamArea$ -It is here noted that the study mentioned above ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)), also suggests a second step. The LISFLOOD model first needs to be run for the entire simulation period length with the initial channel bottom width to get a long-term average discharge ($avgdis$) which is then used in the following *empirical* equation:
+The same study ([Burek et al. (2014)](https://ec-jrc.github.io/lisflood/pdfs/Dataset_hydro.pdf)), also suggests a second step, which relates *chanbw* to average discharge value. The initial channel bottom width from step1 is used to run a OS LISFLOOD simulation for at least a few years to compute a long-term average discharge ($avgdis$). This latter value is then used in the following *empirical* equation:
$chanbw_{step2} = avgdis^{0.539}$ From a470fd082c43b080d613138bdf1479c6fb280ac4 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 29 Apr 2026 12:47:40 +0200 Subject: [PATCH 32/70] small edits 2_ESSENTIAL_time-management --- docs/2_ESSENTIAL_time-management/index.md | 50 ++++++++++++----------- 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/2_ESSENTIAL_time-management/index.md b/docs/2_ESSENTIAL_time-management/index.md index 8f71627c..3041879f 100644 --- a/docs/2_ESSENTIAL_time-management/index.md +++ b/docs/2_ESSENTIAL_time-management/index.md @@ -15,14 +15,17 @@ Outputs of LISFLOOD model will use the same naming convention. If timestamp "0 In Settings file, three different keys are used to specify start date, end date and state file date for LISFLOOD simulation: - **StepStart:** this key specifies the starting date of the simulation. The starting date is also the date of the first LISFLOOD output. - In Settings.xml*: * - For example, if we set StepStart to "02/01/2017 06:00", this means that LISFLOOD will automatically use forcing data with timestamp "02/01/2017 06:00" (i.e. accumulated rainfall over the period between "01/01/2017 06:00" and "02/01/2017 06:00") and it will also store outputs with the same timestamp (i.e. average discharge over the period between "01/01/2017 06:00" and "02/01/2017 06:00"). + >In Settings.xml: textvar name="StepStart" value="02/01/2017 06:00" + + >For example, if we set StepStart to "02/01/2017 06:00", this means that LISFLOOD will automatically use forcing data with timestamp "02/01/2017 06:00" (i.e. accumulated rainfall over the period between "01/01/2017 06:00" and "02/01/2017 06:00") and it will also store outputs with the same timestamp (i.e. average discharge over the period between "01/01/2017 06:00" and "02/01/2017 06:00"). + - **StepEnd:** this key specifies the end date of the simulation. The end date is also the date of the last LISFLOOD output. - In Settings.xml*: * - For example, if we set StepEnd to "05/01/2017 06:00", this means that last output from LISFLOOD run will have timestamp "05/01/2017 06:00" -- **timestepInit:** this key is used to specify which timestamp must be used to retrieve information from existing state files (i.e. from a previous simulation) - For example, if we want to start a new simulation at "03/01/2017 06:00" and we want to use hydrological state information from the last time step, we will set timestepInit to "02/01/2017 06:00". Outputs with timestamp "02/01/2017 06:00" will be used to initialize the model, while the first output of the simulation will be be store with timestamp "03/01/2017 06:00" + >In Settings.xml: textvar name="StepEnd value="05/01/2017 06:00" + > For example, if we set StepEnd to "05/01/2017 06:00", this means that last output from LISFLOOD run will have timestamp "05/01/2017 06:00" + +- **timestepInit:** this key is used to specify which timestamp must be used to retrieve information from existing state files (i.e. from a previous simulation) + >For example, if we want to start a new simulation at "03/01/2017 06:00" and we want to use hydrological state information from the last time step, we will set timestepInit to "02/01/2017 06:00". Outputs with timestamp "02/01/2017 06:00" will be used to initialize the model, while the first output of the simulation will be be store with timestamp "03/01/2017 06:00" ![](../media/image64.png) > **Both timestamps and time steps ALWAYS refer to the END of the TIME INTERVAL!** @@ -30,21 +33,14 @@ In Settings file, three different keys are used to specify start date, end date ## Using timestamps -Timestamps (dates) can now be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart. +Timestamps (dates) can be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart. If hours:minutes are not specified, LISFLOOD will automatically set them to 00:00 -When using timestamps, CalendarDayStart key in Settings.xml is only used internally to transform timestamps to model's time steps and it is usually set equal to StepStart, +When using timestamps, CalendarDayStart key in Settings.xml is only used internally to transform timestamps to model's time steps. -StepStart, StepEnd and timestepInit are used to access NetCDF files containing forcings and state variables, and to create output NetCDF files. +StepStart, StepEnd and timestepInit are used to access NetCDF files containing forcings and state variables, and to create output NetCDF files. -## Using time steps - -Time steps can still be used to set start step and end step of LISFLOOD simulation. ReportSteps can only be provided as time steps numbers. - -All steps numbers are referred to CalendarDayStart - -When using time steps, dates (including hours and minutes) to retrieve data for forcings and state variables are automatically determined by LISFLOOD. ```xml @@ -52,7 +48,7 @@ When using time steps, dates (including hours and minutes) to retrieve data fo TIME-RELATED CONSTANTS ************************************************************** - + Calendar day of 1st day in model run Day of the year of first map (e.g. xx0.001) even if the model start @@ -69,25 +65,31 @@ When using time steps, dates (including hours and minutes) to retrieve data fo Sub time step used for kinematic wave channel routing [seconds] - Within the model,the smallest out of DtSecChannel and DtSec is used - + Number of first time step in simulation - + Number of last time step in simulation - + - Time steps at which to write model state maps (i.e. only - those maps that would be needed to define initial conditions - for succeeding model run) + Time steps at which to write model state maps ``` + + +## Using time steps + +Time steps can still be used to set start step and end step of LISFLOOD simulation. ReportSteps can only be provided as time steps numbers. + +All steps numbers are referred to CalendarDayStart + +When using time steps, dates (including hours and minutes) to retrieve data for forcings and state variables are automatically determined by LISFLOOD. From c966832c47deee31b5d582315a038164ecfd11c2 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 29 Apr 2026 12:48:53 +0200 Subject: [PATCH 33/70] small edits 2_ESSENTIAL_time-management --- docs/2_ESSENTIAL_time-management/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/2_ESSENTIAL_time-management/index.md b/docs/2_ESSENTIAL_time-management/index.md index 3041879f..17d46fcb 100644 --- a/docs/2_ESSENTIAL_time-management/index.md +++ b/docs/2_ESSENTIAL_time-management/index.md @@ -26,6 +26,7 @@ In Settings file, three different keys are used to specify start date, end date - **timestepInit:** this key is used to specify which timestamp must be used to retrieve information from existing state files (i.e. from a previous simulation) >For example, if we want to start a new simulation at "03/01/2017 06:00" and we want to use hydrological state information from the last time step, we will set timestepInit to "02/01/2017 06:00". Outputs with timestamp "02/01/2017 06:00" will be used to initialize the model, while the first output of the simulation will be be store with timestamp "03/01/2017 06:00" + ![](../media/image64.png) > **Both timestamps and time steps ALWAYS refer to the END of the TIME INTERVAL!** From f898c5ca098530a3ae0a327dbe1a360de46ee71a Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 29 Apr 2026 17:03:27 +0200 Subject: [PATCH 34/70] update step3 preparing setting file --- docs/3_step3_preparing-setting-file/index.md | 179 +++++++++++-------- 1 file changed, 101 insertions(+), 78 deletions(-) diff --git a/docs/3_step3_preparing-setting-file/index.md b/docs/3_step3_preparing-setting-file/index.md index 43c63a8a..3b32b75a 100644 --- a/docs/3_step3_preparing-setting-file/index.md +++ b/docs/3_step3_preparing-setting-file/index.md @@ -1,15 +1,15 @@ # Step 2: Preparing the Settings file -This page describes how to prepare your own settings file. Instead of writing the settings file completely from scratch, we suggest to use the settings template that is provided with LISFLOOD as a starting point. In order to use the template, you should make sure the following requirements are met: +This page describes how to prepare your own settings file. Instead of writing the settings file completely from scratch, we suggest usinng the [reference settings file](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml) as a starting point. - - All input maps and tables are named according to default file names - - All base maps are in the right directories - - All tables are in one directory - - All meteo input is in one directory - - All Leaf Area Index input is in the right directories +In oder the run a simulation you will need: + + - Meteo input maps + - Static input maps + - Tables (when reservoirs and lakes are included in the modeling excercise) - An (empty) directory where all model data can be written exists -If this is all true, the settings file can be prepared very quickly by editing the items in the 'lfuser' element. The following is a detailed description of the different sections of the 'lfuser' element. The present LISFLOOD version contains process-related parameters (not taking into account the parameters that are defined through the maps). These are all defined in the 'lfuser' element, and default values are given for each of them. Even though *any* of these parameters can be treated as calibration constants, doing so for *all* of them would lead to serious over-parameterisation problems. In the description of these parameters we will therefore provide some suggestions as to which parameters should be used for calibration, and which one are better left untouched. +If this is all true, the settings file can be prepared very quickly by editing the items in the 'lfuser' element. The following is a detailed description of the different sections of the 'lfuser' element. The present LISFLOOD version contains process-related parameters (not taking into account the parameters that are defined through the maps). These are all defined in the 'lfuser' element, and default values are given for each of them. Even though *any* of these parameters can be treated as calibration constants, doing so for *all* of them would lead to serious over-parameterisation problems. In the description of these parameters we will therefore provide some suggestions as to which parameters should be used for calibration, and which ones are better left untouched. For simplicity reasons, we suggest to follow the following steps: 1) specify the file path @@ -17,7 +17,10 @@ For simplicity reasons, we suggest to follow the following steps: 3) parameter options 4) chose optional model routines (which ones are available; what they do; and how to “activate” them) -In order to facilitate the preparation of the settings file, a complete example is provided [here](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template. Please note that the template contains all the settings for a warm start run; the paths to the initial maps must be replaced with the initial bogus values in order to perform a pre-run or a cold start run. +When using the [reference settings .xml](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml), the user is encouraged to update paths, names of maps and of tables. For instance, users can decide to organize static, meteo, parameter maps in sub-folders or include all maps (and even tables) in one folder. + +>Please note that the template contains all the settings for a warm start run; the paths to the initial maps must be replaced with the initial bogus values in order to perform a pre-run or a cold start run. + TIP: *$(ProjectDir)* or *$(ProjectPath)* cab used as built-in variable in the XML settings, to refer the project folder. ### Time-related constants @@ -30,13 +33,9 @@ The 'lfuser' section starts with a number of constants that are related to the s TIME-RELATED CONSTANTS ************************************************************** - + - Calendar day of 1st day in model run - Day of the year of first map (e.g. xx0.001) even if the model start - from map e.g. 500 - e.g. 1st of January: 1; 1st of June 151 (or 152 in leap year) - Needed to read out LAI tables correctly + Calendar day used as reference for reporting steps @@ -44,46 +43,44 @@ The 'lfuser' section starts with a number of constants that are related to the s timestep [seconds] - + Sub time step used for kinematic wave channel routing [seconds] Within the model,the smallest out of DtSecChannel and DtSec is used - + - Number of first time step in simulation + First time stamp in simulation - Number of last time step in simulation + Last time stamp in simulation - + - Time steps at which to write model state maps (i.e. only - those maps that would be needed to define initial conditions - for succeeding model run) + Time steps at which to write model state maps (in the example above all steps are written) ``` -- **CalendarDayStart** is the calendar day of the first timestep of input mapstacks. - Even if you start the model from time step 500, this has to be set to the calendar day of the first map. +- As a good practice, **CalendarDayStart** shoudl be set equal to the calendar day of the first timestep of input mapstacks. + Format can be a date in several formats, as long as day number is in first position. eg: -
*Value="01/01/1990" = $1^{st}$ January 1990* -
*Value="05.07.1990" = $5^{st}$July 1990* -
*Value="15-11-1990" = $15^{st}$ November 1990* +
*Value="02/01/1990" = $2^{nd}$ January 1990* +
*Value="05.07.1990" = $5^{th}$July 1990* +
*Value="15-11-1990" = $15^{th}$ November 1990* - **DtSec** is the simulation time interval in seconds. It has a value of 86400 for a daily time interval, 3600 for an hourly interval, etcetera. - **DtSecChannel** is the simulation time interval used by the kinematic wave channel routing (in seconds). Using a value that is smaller than **DtSec** may result in a better simulation of the overall shape the calculated hydrograph (at the expense of requiring more computing time). -- **StepStart** is the date of the first time step in your simulation. +- **StepStart** is the date of the first time step in your simulation (defined according to [OS LISFLOOD time stamp convention](/2_ESSENTIAL_time-management/index.md)). -- **StepEnd** is the date of the last time step in your simulation. +- **StepEnd** is the date of the last time step in your simulation (defined according to [OS LISFLOOD time stamp convention](/2_ESSENTIAL_time-management/index.md)). **ReportSteps** defines the time step number(s) at which the model state (i.e. all maps that you would need to define the initial conditions of a succeeding model run) is written. Note that this option only impacts the output frequency of the model state variables (activated by the "repStateMaps" option), not to the auxiliary variables. The full list of the affected variables is [here](../4_annex_state-variables). You can define this parameter in the following ways: @@ -189,7 +186,8 @@ The following parameters are all related to the simulation of [snow accumulation Snowmelt coefficient [mm/deg C /day] - See also Martinec et al., 1998. + See also Martinec et al., 1998. + Often used as calibration parameter. @@ -265,13 +263,15 @@ The following two parameters control the simulation of infiltration and preferen - Power in Xinanjiang distribution function + Power in Xinanjiang distribution function. + Often used as calibration parameter. Power that controls increase of proportion of preferential - flow with increased soil moisture storage + flow with increased soil moisture storage. + Often used as calibration parameter. ``` @@ -282,7 +282,7 @@ The following two parameters control the simulation of infiltration and preferen ### Groundwater parameters -The following parameters control the [simulation of shallow and deeper groundwater](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/) *GwLossFraction* should be kept at 0 unless prior information clearly indicates that groundwater is lost beyond the catchment boundaries (or to deep groundwater systems). The other parameters are treated as calibration constants. All these parameters can be defined as single values or maps. +The following parameters control the [simulation of shallow and deeper groundwater](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/). All these parameters can be defined as single values or maps. ```xml @@ -292,29 +292,28 @@ The following parameters control the [simulation of shallow and deeper groundwat - Time constant for water in upper zone [days] + Time constant for water in upper zone [days] + Often used as calibration parameter. Time constant for water in lower zone [days] - This is the average time a water \'particle\' remains in the - reservoir - if we had a stationary system (average inflow=average outflow) + Often used as calibration parameter. Maximum rate of percolation going from the Upper to the Lower - response box [mm/day] + response box [mm/day] + Often used as calibration parameter. Maximum rate of percolation from the Lower response box (groundwater loss) [mm/day]. - A value of 0 (closed lower boundary) is recommended as a starting - value + Often used as calibration parameter. ``` @@ -340,7 +339,8 @@ These parameters are all related to the [routing of water in the channels](https - Multiplier applied to Channel Manning's n + Multiplier applied to Channel Manning's n + Often used as calibration parameter. @@ -361,7 +361,8 @@ These parameters are all related to the [routing of water in the channels](https - Minimum channel gradient (for kin. wave: slope cannot be 0) + Minimum channel gradient (for kin. wave: slope cannot be 0) + Coould be set to 0.00001 when using kinematic and diffusive wave modelling ``` @@ -472,17 +473,21 @@ Here you can define the prefix that is used for each meteorological variable, LA prefix ET0 maps - + prefix LAI maps - + prefix forest LAI maps - + + + + prefix irrigated fraction LAI maps + - + prefix water use maps @@ -499,18 +504,25 @@ Here you can define the prefix that is used for each meteorological variable, LA - **PrefixET0** is the prefix of the potential (reference) evapotranspiration maps -- **PrefixLAI** is the prefix of the Leaf Area Index maps +- **PrefixLAI**, **PrefixLAIForest** ,**PrefixLAIIrrigated** are the prefix of the Leaf Area Index maps for the three land cover fractions -- **PrefixLAIForest** is the prefix of the forest Leaf Area Index maps +- **PrefixWaterUseDomestic** is the prefix of the domestic [water use maps](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) (optional). Domestic use was indicated here as an example. -- **PrefixWaterUse** is the prefix of the [water use maps](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) (optional) +### Initial conditions: OS LISFLOOD prerun, cold start, warm start -### Initial conditions +OS LISFLOOD prerun simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun can also be referred to as initialization run. This simulation must always be performed. OS LISFLOOD prerun output must be used to initialize the OS LISFLOOD cold start run. -As with the calibration parameters you can use both maps and single values to define the catchment conditions at the start of a simulation. -Note that a couple of variables can be [initialized internally](https://ec-jrc.github.io/lisflood-code/3_step5_model-initialisation/) in the model. Also, be aware that the initial conditions define the state of the model at *t=(StepStart -1)*. As long as *StepStart* equals 1 this corresponds to *t=0*, but for larger values of *StepStart* this is (obviously) not the case! +OS LISFLOOD cold start run and warm start run deliver the actual model outputs to be usef for analysis/forecasts. + +OS LISFLOOD cold start run takes as input the OS LISFLOOD prerun output for the slow storages, while fast(er) respoding storages (e.g. channel volume) are set to bogus values. It is always recommended to discard the initial (3) years of the OS LISFLOOD cold start to allow adequate initialization of fast(er) respoding storages. + +OS LISFLOOD warm start resumes the computations from the end states of a preceeding simulation (cold start or warm start). + +A dedicated chapter about [model initialization](https://ec-jrc.github.io/lisflood-code/3_step5_model-initialisation/) provides more in-depth explanations of model prerun (initialization), cold start, and warm start. + +This page has the purpose to provide an overview of the variables requiring an initial value. Initial values shown in this page refer to a model prerrun simulation. ```xml @@ -519,10 +531,18 @@ Note that a couple of variables can be [initialized internally](https://ec-jrc.g (maps or single values) ************************************************************** - + - initial overland flow water depth [mm] - + initial overland flow water volume, direct runoff fraction [m3] + + + + initial overland flow water volume, other + irrigated fraction [m3] + + + + initial overland flow water volume, forest fraction [m3] + @@ -607,6 +627,12 @@ Note that a couple of variables can be [initialized internally](https://ec-jrc.g -9999: use discharge of half bankfull + + + Outflow average discharge on previous routing sub-step (average) [m3/s] + Cold start: -9999 sets initial value to 0 + + Courant number at previous step for MCT routing @@ -621,7 +647,7 @@ Note that a couple of variables can be [initialized internally](https://ec-jrc.g ``` -- **WaterDepthInitValue** is the initial amount of water on the soil surface $[mm]$ +- **OFDirect/Other/ForestInitValue** is the initial amount of water on the soil surface $[m^3]$ - **SnowCoverInitAValue** is the initial snow cover on the soil surface in elevation zone **A** $[mm]$ @@ -639,7 +665,7 @@ Note that a couple of variables can be [initialized internally](https://ec-jrc.g - **CumIntSealedInitValue** is the initial value of the depression storage for the sealed part of a pixel $[mm]$ -- **LZInitValue** is the initial storage in the lower groundwater zone $[mm]$. In order to avoid initialization problems it is possible to let the model calculate a 'steady state' storage that will usually minimize any initialization problems. This feature is described in detail in Chapter 7 of this User Manual. To activate it, set the lfoptions element InitLisflood to 1. +- **LZInitValue** is the initial storage in the lower groundwater zone $[mm]$. In order to avoid initialization problems it is possible to let the model calculate a 'steady state' storage. Users are recommended to refer to the chapter on [model initialization](https://ec-jrc.github.io/lisflood-code/3_step5_model-initialisation/) - **TotalCrossSectionAreaInitValue** is the initial cross-sectional area $[m^2]$ of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). A value of **-9999 ** sets the initial amount of water in the channel to half bankfull. @@ -649,7 +675,7 @@ Note that a couple of variables can be [initialized internally](https://ec-jrc.g - **ThetaInit3Value** is the initial moisture content $[\frac{mm^3} {mm^3}]$ of the lower soil layer (2). A value of -**9999** will set the initial soil moisture content to field capacity. -- **PrevDischarge** is the initial discharge from previous run $[\frac{m^3} {s}]$ used for lakes, reservoirs and transmission loss (only needed if option is on for lakes or reservoirs or transmission loss). Note that PrevDischarge is discharge as an average over the time step (a flux) . A value of **-9999** sets the initial amount of discharge to equivalent of half bankfull. +- **PrevDischarge** and **PrevDischargeAvg** are the initial discharge from previous run (instantaneous and average values in the last sub-roting step) $[\frac{m^3} {s}]$ used for lakes, reservoirs and transmission loss (only needed if option is on for lakes or reservoirs or transmission loss). A value of **-9999** sets the initial amount of discharge to equivalent of half bankfull. - **PrevCmMCTInitValue** is the Courant number at the end of the previous step and it is only used for MCT wave routing [-]. A value of **-9999 ** sets the initial value to 1. @@ -676,13 +702,7 @@ Note that a couple of variables can be [initialized internally](https://ec-jrc.g days since last rainfall - - - - water in lower store [mm] - -9999: use steady-state storage - - + initial soil moisture content layer 1 @@ -701,21 +721,21 @@ Note that a couple of variables can be [initialized internally](https://ec-jrc.g -9999: use field capacity values ``` -CumIntForestInitValue, UZForestInitValue, DSLRForestInitValue, LZForestInitValue, ThetaForestInit1Value, ThetaForestInit2Value, ThetaForestInit3Value are the initial value for the forest part of a pixel. +CumIntForestInitValue, UZForestInitValue, DSLRForestInitValue, ThetaForestInit1Value, ThetaForestInit2Value, ThetaForestInit3Value are the initial values for the forest part of a pixel when performing a **cold start**. ### Using options -As explained in [Step 0](../2_ESSENTIAL_setting-file/), the 'lfoptions' element gives you additional control over what LISFLOOD is doing. Using options it is possible to switch certain parts of the model on or off. You can decide which output files are reported and which ones aren't. Moreover, you can activate a number of additional model features, such as the simulation of reservoirs and inflow hydrographs. +The 'lfoptions' element (explained in [this page](../2_ESSENTIAL_setting-file/)) allows to activate or deactivate optional modules (e.g. the simulation of reservoirs), as well as to select the list of output files. -A list of all currently implemented options and their corresponding defaults can be found in the [LISFLOOD model documentation](https://ec-jrc.github.io/lisflood-model/). -All currently implemented options are switches (1= on, 0=off). -You can set as many options as you want (or none at all). Note that each option generally requires additional items in the settings file. +The [LISFLOOD model documentation](https://ec-jrc.github.io/lisflood-model/) explains standard and optional modules. +Optional modules and output variables are selected using switches: 1= on, 0=off. +Users can set different combinations of optional modules and outputs (or none at all). Each optional module generally requires additional items in the settings file. For instance, using the inflow hydrograph option requires an input map and time series, which have to be specified in the settings file. -If you want to report discharge maps at each time step, you will first have to specify under which name they will be written. +If you want to report discharge maps at each time step, you will first have to specify the writing path and desired file name. -The template settings file that is provided with LISFLOOD always contains file definitions for all optional output maps and time series. +The [refernce xml settings file](https://github.com/ec-jrc/lisflood-code/blob/master/src/lisfloodSettings_reference.xml) includes definitions for most of the optional output maps and time series. The use of the *output* options is described in detail in [a dedicated section](../4_annex_output-files/). Within the 'lfoptions' element of the settings file, each option is defined using a 'setoption' element, which has the attributes 'name' and 'choice' (i.e. the actual value). For example: @@ -726,14 +746,17 @@ Within the 'lfoptions' element of the settings file, each option is defined usin ``` -### Options to manage input and output files +### Options to manage input files + ++ **NetCDFTimeChunks**: chunking size in the time dimension. This option was implemented to optimize the loading of the meteo maps. Recommended value is “auto" but chunking size can be specified manually (e.g. "10") or set to “-1" to load the whole time series into memory (very fast but expensive in terms of memory). ++ **MapsCaching** (True or False): option designed for lisflood calibration. If set to True, all the static maps and forcings will be stored in a cache so that they don't have to be loaded by each lisflood instance. This option sets the value of NetCDFTimeChunks to "-1", meaning that the whole time series in the NetCDF inputs is loaded into memory. + +### Options to manage output files -+ **NetCDFTimeChunks**: chunking size in the time dimension. Recommended value is “auto" but chunking size can be specified manually or set to “-1" to load the whole time series into memory (very fast but expensive in terms of memory). -+ **MapsCaching** (True or False): option designed for the lisflood calibration. If set to True, all the static maps and forcings will be stored in a cache so that they don't have to be loaded by each lisflood instance. This option sets the value of NetCDFTimeChunks to "-1", meaning that the whole time series in the NetCDF inputs is loaded into memory. -+ **OutputMapsChunks**: this option is used to dump outputs to disk every X steps (default 1). -+ **OutputMapsDataType**: this option sets the output data type and may take the following values: "float64" or "float32" (default float64) ++ **OutputMapsChunks**: this option is used to write output maps every X steps (default 1). ++ **OutputMapsDataType**: this option sets the output data type and may take the following values: "float64" or "float32" (default float64). This option applies to all output maps. ### Reference settings file In order to facilitate the preparation of the settings file, a complete example is provided [here](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template. -[:top:](#top) +[:top:](#top) \ No newline at end of file From a87420349f607716519714c4bb58de99d746b288 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 29 Apr 2026 17:37:20 +0200 Subject: [PATCH 35/70] small fixes step3 preparing setting file --- docs/3_step3_preparing-setting-file/index.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/3_step3_preparing-setting-file/index.md b/docs/3_step3_preparing-setting-file/index.md index 3b32b75a..5d351349 100644 --- a/docs/3_step3_preparing-setting-file/index.md +++ b/docs/3_step3_preparing-setting-file/index.md @@ -627,12 +627,12 @@ This page has the purpose to provide an overview of the variables requiring an i -9999: use discharge of half bankfull - - - Outflow average discharge on previous routing sub-step (average) [m3/s] - Cold start: -9999 sets initial value to 0 - - + + + Outflow average discharge on previous routing sub-step (average) [m3/s] + -9999: use discharge of half bankfull + + Courant number at previous step for MCT routing @@ -677,9 +677,9 @@ This page has the purpose to provide an overview of the variables requiring an i - **PrevDischarge** and **PrevDischargeAvg** are the initial discharge from previous run (instantaneous and average values in the last sub-roting step) $[\frac{m^3} {s}]$ used for lakes, reservoirs and transmission loss (only needed if option is on for lakes or reservoirs or transmission loss). A value of **-9999** sets the initial amount of discharge to equivalent of half bankfull. -- **PrevCmMCTInitValue** is the Courant number at the end of the previous step and it is only used for MCT wave routing [-]. A value of **-9999 ** sets the initial value to 1. +- **PrevCmMCTInitValue** is the Courant number at the end of the previous step and it is only used for MCT wave routing [-]. A value of -**9999 ** sets the initial value to 1. -- **PrevDmMCTInitValue** is the Reynols number at the end of the previous step and it is only used for MCT wave routing [-]. A value of **-9999 ** sets the initial value to 0. +- **PrevDmMCTInitValue** is the Reynols number at the end of the previous step and it is only used for MCT wave routing [-]. A value of -**9999 ** sets the initial value to 0. ```xml From 9cb4ddd545102c8e2af41c45f6ea5b4a87f4e7ad Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 29 Apr 2026 19:37:54 +0200 Subject: [PATCH 36/70] improve description model initialization --- docs/3_step5_model-initialisation/index.md | 120 +++++++++++++++------ 1 file changed, 88 insertions(+), 32 deletions(-) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index c2163403..72bda055 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -1,16 +1,29 @@ # Step 4: Initialisation & cold start of LISFLOOD -Just as any other hydrological model, LISFLOOD needs to know the initial state (i.e. amount of water stored) of its internal state variables in order to be able to produce reasonable discharge simulations. However, in practice we hardly ever know the initial state of all state variables at a given time. Hence, we have to estimate the state of the initial storages in a reasonable way, which is also called the initialisation of a hydrological model. +Just as any other hydrological model, LISFLOOD needs to know the initial state (i.e. amount of water stored in the groundwater zone, soil, channels) of its internal state variables in order to start a simulation. However, in practice we hardly ever know the initial state of all state variables at a given time. Hence, the state of the initial storages must be estimated: this phase is the initialisation of a hydrological model. -In this subsection we will: - 1. demonstrate the effect of the model's initial state on simulation results + +>**OS LISFLOOD prerun** simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun constitutes the **initialization run**. OS LISFLOOD prerun output is used as input to the OS LISFLOOD cold start run. + +>OS LISFLOOD cold start run and warm start run deliver the actual model outputs to be usef for analysis/forecasts. + +>**OS LISFLOOD cold start** run takes as input the OS LISFLOOD prerun output to initialize the slow storages (soil and groundwater). Initial values of fast(er) respoding storages (e.g. channel volume) are set to bogus values. It is always recommended to discard the initial (3) years of the OS LISFLOOD cold start to allow adequate initialization of fast(er) respoding storages. + +>**OS LISFLOOD warm start** resumes the computations from the end states of a preceeding simulation. The set-up of this type of simulation is described in the next section of this user guide. + + +In this page we will: + 1. demonstrate the effect of the model's initial states on simulation results 2. explain the theory of initialisation and the steady-state storage concept - 3. explain how to run the initialisation (pre-run) for kinematic and split routing configurations + 3. explain how to run the pre-run (initialization) for kinematic (kinematic and diffusive) and split routing (split routing and diffusive) routing configurations 4. describe how to use the pre-run outputs to set up a cold start 5. describe how to complete the initialisation in temporal chunks when needed +## The impact of the model initial state on simulation results -## 4.1 The impact of the model's initial state on simulation results +When setting up a simulation, most of the internal state variables can be simply set to 0 at the start of the run. For example, this applies to the initial snow cover (*SnowCoverInitValue*), frost index (*FrostIndexInitValue*), interception storage (*CumIntInitValue*). + +However, this simple approach does not hold for all the state variables. To better understand the impact of the initial model state on the results of a simulation, let's start with a simple example. The Figure below shows 3 LISFLOOD simulations of soil moisture for the upper soil layer. In the first simulation, it was assumed that the soil is initially completely saturated. In the second one, the soil was assumed to be completely dry (i.e. at residual moisture content). Finally, a third simulation was done where the initial soil moisture content was assumed to be in between these two extremes. @@ -18,51 +31,93 @@ To better understand the impact of the initial model state on the results of a s **Figure:** *Simulation of soil moisture in upper soil layer for a soil that is initially at saturation (s), at residual moisture content (r) and in between (\[s+r\]/2)* -What is clear from the Figure is that the initial amount of moisture in the soil only has a marked effect on the start of each simulation; after a few months the three curves converge. In other words, the "memory" of the upper soil layer only goes back a few months (or, more precisely, for time lags of more than about 8 months the autocorrelation in time is negligible). +The initial amount of moisture in the upper soil layer only has a marked effect on the start of each simulation; after a few months the three curves converge. In other words, the "memory" of the upper soil layer only goes back a few months (or, more precisely, for time lags of more than about 8 months the autocorrelation in time is negligible). -In theory, this behaviour provides a convenient and simple way to initialise a model such as LISFLOOD. Suppose we want to do a simulation of the year 1995. We obviously don't know the state of the soil at the beginning of that year. However, we can get around this by starting the simulation a bit earlier than 1995, say one year. In that case we use the year 1994 as a *warm-up* period, assuming that by the start of 1995 the influence of the initial conditions (i.e. 1-1-1994) is negligible. The very same technique can be applied to initialise LISFLOOD's other state variables, such as the amounts of water in the lower soil layer, the upper groundwater zone, the lower groundwater zone, and in the channel. +This behaviour provides a convenient and simple way to initialise the soil moisture state of the upper soil layer. Suppose we want to do a simulation of the year 1995. We obviously don't know the state of the soil at the beginning of that year. However, we can get around this by starting the simulation a bit earlier than 1995, say one year. In that case we use the year 1994 as a *spin-up* period, assuming that by the start of 1995 the influence of the initial conditions (i.e. 1-1-1994) is negligible. -## 4.2 The theory of initialisation +Even though the use of a sufficiently long spin-up period usually results in a correct initialisation of many state variables, the time needed to initialise any storage component of the model is dependent on its specific water average residence time. As briefly shown above, the moisture content of the upper soil layer tends to respond relatively quickly to meteorological forcing variables (precipitation, evapo(transpi)ration). As a result, relatively short spin-up periods are sufficient to initialise this storage component. At the other extreme, the response of the (thick) lower soil layers and of the lower groundwater zone is generally very slow. -When setting up a **model cold run**, most of the internal state variables can be simply set to 0 at the start of the run. For example, this applies to the initial snow cover (*SnowCoverInitValue*), frost index (*FrostIndexInitValue*), interception storage (*CumIntInitValue*). The initial value of the 'days since last rainfall event' (*DSLRInitValue*) is typically set to 1. +To explain the challenge of the adequate initialization of the lower groundwater zone, we resume here the content presented in [this chapter](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/) of OS LISFLOOD Model Documentation. -For soil and groundwater state variables, initialisation is somewhat less straightforward. The amount of water that can be stored in the three soil layers (*ThetaInit1Value*, *ThetaInit2Value*, *ThetaInit3Value*) is limited by the soil's porosity. The lower groundwater zone poses special problems because of its overall slow response (discussed in a separate section below). Because of this, LISFLOOD provides the possibility to initialise these variables internally. The following Table summarises these special initialisation methods: +The Figure below shows the results of two numerical experiments. In the upper Figure, we start with a very high initial storage of the groundwater lower zone (1500 mm). The inflow rate is fairly small (0.2 mm/day), and the outflow rate is relatively large. What is interesting here is that, over time, the storage evolves asymptotically towards a constant state. In the lower Figure, we start with a much smaller initial storage (50 mm), but the inflow rate is much higher (1.5 mm/day) and the outflow rate is much smaller. Here we see an upward trend, again towards a constant value. However, in this case the constant ‘end’ value is not reached within the simulation period. -**Table:** *LISFLOOD special initialisation methods*$^1$ + -| **Variable** | **Description** | **Initialisation method** | -|-------------------------------|-------------------------------|-------------------------------| -| ThetaInit1Value /
ThetaForestInit1Value | initial soil moisture content
upper soil layer (V/V)| set to soil moisture content
at field capacity | -| ThetaInit2Value /
ThetaForestInit2Value | initial soil moisture content
lower soil layer (V/V) | set to soil moisture content
at field capacity | -| LZInitValue /
LZForestInitValue | initial water in lower
groundwater zone (mm) | set to steady-state storage | -| TotalCrossSectionArea
InitValue | initial cross-sectional area
of water in channels | set to half of bankfull depth | -| PrevDischarge | Initial discharge | set to half of bankfull depth | +**Figure** Two 10-year simulations of lower zone storage with constant inflow. Upper Figure: high initial storage, storage approaches steady-state storage +(dashed) after about 1500 days. Lower Figure: low initial storage, storage doesn’t reach steady-state within 10 years. + +At this point it should be clear that being able to know the ‘end’ storages in the Figure above in advance would be very helpful, because it would eliminate any trend in the water content of the lower groundwater zone. + +A similar reasoning applies to the soil water content of the third soil layer. + +Spurious trends in the soil layers and in the lower groundwater zone will obviously lead to spurious trends in the baseflow simulations. Consequently, to avoid unrealistic trends in the simulations, very long spin-up periods may be needed, thus requiring a large amount of computational and time resources. + +To by-pass the need for excessively long spin-up periods, LISFLOOD is capable of calculating a *steady-state* storage amount for the third soil layer and for the lower groundwater zone. This *steady state* storage, introduced in this [chapter](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/), is very effective for reducing spin-up time. + +The following paragraphs explain how the analytical solutions can be used to leverage on the **outputs of a OS LISFLOOD prerun** to adequately initialize volumetric soil moisture content and lower groundwater zone water content of a **OS LISFLOOD cold start**. + +The complete list of initial state values for a **OS LISFLOOD prerun** is presented [here](https://github.com/ec-jrc/lisflood-code/blob/feature/docs/docs/3_step3_preparing-setting-file/index.md#initial-conditions-os-lisflood-prerun-cold-start-warm-start). The only relevant outputs of the OS LISFLOOD prerun are: +- end states of volumetric soil content and upper groundwater zone water content; +- average fluxes values (from upper to lower soil layer, net inflow to the lower groundwater zone); +- average discharge (when using SplitRouting). -$^1$ These special initialisation methods are activated by setting the value of each respective variable to a 'bogus' value of "-9999"* -Note that the "-9999" 'bogus' value can *only* be used with the variables in the Table above; the use of the 'bogus' value for all the other variables will produce nonsense results! For this reason, the initialisation of the lower groundwater zone is necessary.
+### Initialization of soil moisture content -*WARNING!* In some areas, the use of initial soil water content equal to field capacity leads to nonrealistic trends in soil moisture content and to fictitious discharge values in the channels.
-The issue above can occur, for instance, in catchments with arid climate and very thick (~10^2) soil layers or in catchments in very cold area where frost conditions are frequent. +> An improved initialization scheme has been implemented in OS-LISFLOOD v5.0.0, allowing to remove non-realistic trends in soil moisture content and fictitious discharge values in the channels previously observed, for example, in arid climates. Albeit the former initialization strategy with bogus values is still feasibile, the use of the methodology explained here is highly recommended, for all modelling excercises. -To avoid nonrealistic results in such specific contexts, an improved initialization scheme has been implemented in OS-LISFLOOD v5.0.0. +OS LISFLOOD prerun provides in output end states and average fluxes. The end states are the volumetric soil moisture content for the three soil layers and the three land covers (9 maps). The average fluxes represent the average infiltration (over the simulation period) from the soil layer 2 to soil layer 3, for the three land cover fractions (3 maps indicated as *SeepTopToSubBAverageXX*). In the cold run, the end states are used to initialise the volumetric soil moisture content of soil layers 1 and 2. The initialisation of the volumetric soil moisture content of soil layer 3 makes use of the relevant end state and of the fluxes. +Accorind to the steady-state approach, the model tries to enable long term equilibrium conditions between average inflow and outflow fluxes in the third soil layer. -**Initialization of the soil moisture content**: the prerun provides in output end states and average fluxes. The end states are the volumetric soil moisture content for the three soil layers and the three land covers (9 maps). The average fluxes represent the average infiltration (over the simulation period) from the soil layer 2 to soil layer 3, for the three land cover fractions (3 maps indicated as *SeepTopToSubBAverageXX*). In the cold run, the end states are used to initialise the volumetric soil moisture content of soil layers 1 and 2. The initialisation of the volumetric soil moisture content of soil layer 3 makes use of the relevant end state and of the fluxes, following the same reasoning implemented for the lower groundwater zone (see below), the model tries to enable long term equilibrium conditions between average inflow and outflow fluxes in the third soil layer. In more detail, for soil layer 3, the average seepage maps as well as an .end map are produced that later serves as a starting guess for solving the second-order, non-linear Van Genuchten equation. Accounting for an adequate spin-up period of the initialization run allows and is recommended to compute realistic average fluxes values. This latter outcome can be achieved by adequately setting the value of *NumDaysSpinUp*. +ADD EQUATION!!! -**Initialization of the upper groundwater zone** water content: it is recommended to use the end state generated by the prerun.
+In more detail, for soil layer 3, the average seepage maps as well as an .end map are produced that later serves as a starting guess for solving the second-order, non-linear Van Genuchten equation. Accounting for an adequate spin-up period of the initialization run allows and is recommended to compute realistic average fluxes values. This latter outcome can be achieved by adequately setting the value of *NumDaysSpinUp*. -*Please note that the content of this paragraph does not apply to the runs with warm start!*
-**Initialisation of the lower groundwater zone** -Even though the use of a sufficiently long warm-up period usually results in a correct initialisation, a complicating factor is that the time needed to initialise any storage component of the model is dependent on the average residence time of the water in it. For example, the moisture content of the upper soil layer tends to respond almost instantly to LISFLOOD's meteorological forcing variables (precipitation, evapo(transpi)ration). As a result, relatively short warm-up periods are sufficient to initialise this storage component. At the other extreme, the response of the lower groundwater zone is generally very slow (especially for large values of $T_{lz}$). Consequently, to avoid unrealistic trends in the simulations, very long warm-up periods may be needed. The Figure below shows a typical example for an 8-year simulation, in which a decreasing trend in the lower groundwater zone is visible throughout the whole simulation period. Because the amount of water in the lower zone is directly proportional to the baseflow in the channel, this will obviously lead to an unrealistic long-term simulation of baseflow. Assuming the long-term climatic input is more or less constant, the baseflow (and thus the storage in the lower zone) should be free of any long-term trends (although some seasonal variation is normal). In order to avoid the need for excessive warm-up periods, LISFLOOD is capable of calculating a *steady-state* storage amount for the lower groundwater zone. This *steady state* storage is very effective for reducing the lower zone's warm-up time. The concept of *steady state* is explained in the [LISFLOOD model description](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/), here we will show how it can be used to speed up the initialisation of a LISFLOOD run. +### Initialization of the upper groundwater zone +To initialize the upper groudwater zone water content it is recommended to use the end state generated by the prerun.
-**Steady-state storage in practice** -An actual LISFLOOD simulation differs from the theoretical *steady state*: -The steady-state storage $LZ_{ss}$ is directly proportional to the average recharge into the lower groundwater zone. In practice, this average recharge cannot be known a priori for two reasons: it varies in time rather than being constant, and it is controlled by the availability of water in the upper groundwater zone, which in turn depends on the supply of water from the soil. Hence, during calibration the average recharge will differ for every parameter set since it depends on soil and subsoil parameters (e.g. $T_{uz}$, $GW_{perc}$, $b$, and so on). Note, however, that the average recharge will *always* be smaller than the value of $GW_{perc}$, which is used as an upper limit in the model. Therefore $LZ_{ss}$ and hence the correct initial storage can only be reliably estimated after running the model via *average* recharge, which is one of the purpose of the pre-run. +### Initialisation of the lower groundwater zone + +The condition in which *the lower groundwater zone storage is constant over time means that the in- and outflow terms balance each other out*. This condition is known as a **steady state situation**, and the constant ‘end’ storage is in fact the *steady state storage*. +The rate of change of the lower zone’s storage at any moment is given by the continuity equation: + +$$ +\frac{dLZ}{dt}=I(t)-O(t) +$$ + +where $I$ is the inflow (i.e. groundwater recharge) and $O$ is the outflow rate. For a situation where the storage remains constant, we can write: +
$\frac{dLZ}{dt}=0$ only if $I(t)=O(t)$ + +This equation can be re-written as: +
$I(t) = \frac{1}{T_{lz}} \cdot LZ$ + +Solving this for LZ gives the steady state storage: +
$LZ_{ss} = T_{lz} \cdot I(t)$ + +T_{lz} is a parameter provided as input to the model. +The OS LISFLOOD preun is used to compute $I(t)$, here defined as the average net inflow to the lower groundwater zone: $LZavin$. +T_{lz} and $LZavin$ allow to obtain LZ *steady state storage* value. + +For this purpose, the prerun must include a sufficiently long simulation period (a few decades) to allow the computation of representative values of LZavin. The set-up of the prerun run is explained below; the protocol differs slightly depending on the settings of the split routing option. + +**Table:** LISFLOOD special initialisation methods activated by setting the value of each respective variable to a 'bogus' value of -9999 + +| **Variable** | **Description** | **Initialisation method** | +|-------------------------------|-------------------------------|-------------------------------| +| ThetaInit1Value
ThetaForestInit1Value
ThetaIrrigationInit1Value | initial volumetric soil moisture content
superficial soil layer (V/V)| set to soil moisture content
at field capacity, recommended only in LISFLOOD **prerun**| +| ThetaInit2Value
ThetaForestInit2Value
ThetaIrrigationInit2Value | initial volumetric soil moisture content
upper soil layer (V/V) | set to soil moisture content
at field capacity, recommended only in LISFLOOD **prerun** | +| ThetaInit3Value
ThetaForestInit3Value
ThetaIrrigationInit3Value | initial volumetric soil moisture content
lower soil layer (V/V) | set to soil moisture content
at field capacity, recommended only in LISFLOOD **prerun** | +| LZInitValue | initial water in lower
groundwater zone ($mm$) | set to steady-state storage, only used in LISFLOOD **coldstart** | +| TotalCrossSectionArea
InitValue | initial cross-sectional area ($m^2$)
of water in channels | set to half of bankfull depth, used in LISFLOOD **prerun and coldstart** | +| PrevDischarge
PrevDischargeAvg | Initial discharge ($m^3/s$) | set to half of bankfull depth, used in LISFLOOD **prerun and coldstart** | + + +*Note that the "-9999" 'bogus' value can *only* be used with the variables in the Table above; the use of the 'bogus' value for all the other variables will produce nonsense results!
* + -As an alternative to using the internal initialization (and hence the bogus values), LZavin and AvgDis (LZInitValue and PrevDischarge) can be computed using an initialization run (or pre-run). The pre-run procedure must include a sufficiently long warm-up period to allow the computation of reliable values of LZavin and AvgDis. The set-up of the initialization run is explained in Section 4.3; the protocol differs slightly depending on the settings of the split routing option. ## 4.3 What you need to do: @@ -563,3 +618,4 @@ These outputs are: * SeepTopToSubBAverageForestMap.nc, average flux from second to third soil layer - forest land cover fraction * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction + From 530be51994968eeb589d9fd4a4f6e0bc08c9b9ba Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 10:25:46 +0200 Subject: [PATCH 37/70] review step4_preparing-input-files --- docs/3_step4_preparing-input-files/index.md | 67 ++++++++------------- 1 file changed, 26 insertions(+), 41 deletions(-) diff --git a/docs/3_step4_preparing-input-files/index.md b/docs/3_step4_preparing-input-files/index.md index b0d545ad..1067b23c 100644 --- a/docs/3_step4_preparing-input-files/index.md +++ b/docs/3_step4_preparing-input-files/index.md @@ -1,31 +1,36 @@ ## Step 3: Input files (maps and tables) -In the current version of LISFLOOD, all the model inputs are provided as either maps (grid files in PCRaster format or NetCDF format) or text files (.txt extension). This chapter provides an overview of the data set that is required to run the model. +In the current version of OS LISFLOOD, all the model inputs are provided as either maps (NetCDF format) or text files (.txt extension). This chapter provides an overview of the data set that is required to run the model. ### INPUT MAPS +> Albeit OS LISFLOOD can still read maps in pcraster format, users are strongly recommended to prepare their own input maps in NetCDF format: pcraster format will be discarded in future versions of OS LISFLOOD (timeline not yet defined). + LISFLOOD requires that all maps must have *identical* location attributes (number of rows, columns, cellsize, upper x and y coordinates). The input maps can be classified according to two main categories:
+ **meteorological forcings**. These maps provide time series of values for each pixel of the computational domain. More specifically, the meteorological forcings provide the values of precipitation, temperature, reference values of evaporation from water surfaces, reference values of evaporation from open water bodies, reference values of evapotranspiration for each pixel of the modelled area. For each meteorological forcing, one map is required for each computational time step.
+ **static maps**. These maps provide information of morphological, physical, soil, and land use properties for each pixel of the computational domain. - ### Meteorological forcings -The meteorological forcing variables are defined in *map stacks*. A *map stack* is simply a series of maps, where each map represents the value of a variable at an individual time step.
It is recommented to use the netcdf format.
LISFLOOD is capable of reading meteorological forcings split into multiple files (e.g. yearly chuncks). To use this functionality, it is enough to add the symbol '\*' after the file name (e.g. ET0_\*)
The users that prefer to prepare the meteorological forcings maps in pcraster format, must name the files according to the following rules: the name of each map is made up of a total of 11 characters: 8 characters, a dot and a 3-character suffix. Each map name starts with a *prefix*, and ends with the time step number. All character positions in between are filled with zeros ("0").
+The meteorological forcing variables are defined in *map stacks*. A *map stack* is simply a series of maps, where each map represents the value of a variable at an individual time step.
It is recommented to use the netcdf format.
LISFLOOD is capable of reading meteorological forcings split into multiple files (e.g. yearly chuncks). To use this functionality, it is enough to add the symbol '\*' after the file name (e.g. ET0_\*). Generally used prefixes for the meteorological forcings maps are:
+ tp : total precipitation; units: mm/day.
-+ ta : average daily temperature at 2m; units: degrees Celsius or Kelvin (the units must be specified in the [settings file](../3_step3_preparing-setting-file/))
++ ta : average temperature at 2m within the time computational step: degrees Celsius or Kelvin (the units must be specified in the [settings file](../3_step3_preparing-setting-file/))
+ EW0 : reference value of evaporation from open water bodies; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
+ ES0 : reference value of evaporation from bare soil; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
+ ET0 : reference value of evapotranspiration; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
+> Cumulative quantities (total precipitation, reference values of evaporation and evapotranspiration) must always be provided in $mm/day$, also when performing a simulation with sub-daily (hourly) computational time step: OS LISFLOOD will internally convert values provided in $mm/day$ to the desidered temporal resolution. For example, total precipitation values for a simulation with 6h computational time step must be provided every 6 hours, but 6 hours cumulative values are multipied by 4 ($mm/day$). + + +*Note for pcraster users only:* File names of meteorological forcings maps in pcraster format must adhere to pre-defined rules. The name of each map is made up of a total of 11 characters: 8 characters, a dot and a 3-character suffix. Each map name starts with a *prefix*, and ends with the time step number. All character positions in between are filled with zeros ("0").
### Static maps -The section [Static Maps](../4_Static-Maps-introduction) provides detailed guidelines for the preparation of the static maps data set. The following paragraph provides an overview of the different piecies of information provided by the static maps. +The section [Static Maps](../4_Static-Maps-introduction) provides detailed guidelines for the preparation of the static maps data set. The following paragraph provides an overview of the information provided by the static maps. + [general maps](../4_Static-Maps_general-maps/): area mask; landuse mask; grid-cell length; grid-cell area. + [topography](../4_Static-Maps_topography/): local drain direction; gradient; standard deviation of elevation; upstream area. + [land use maps](../4_Static-Maps_land-use/): fraction of forest; fraction of irrigated crops; fraction of rice crops; fraction of inland water; fraction of sealed surfaces; fraction of other land uses. @@ -34,27 +39,27 @@ The section [Static Maps](../4_Static-Maps-introduction) provides detailed guide + [channel geometry](../4_Static-Maps_channel-geometry/): channels mask; channels side slope; channels length; channels gradient; Manning's rougheness coefficient of the channels; channels bottom width; floodplain width; bankfull channels depth; MCT diffusive wave routing channels. + [leaf area index](../4_Static-Maps_leaf-area-index/): evolution of vegetation over time (leaf area index) for land covers forest, irrigated areas, others. + [reservoirs and lakes](../4_Static-Maps_reservoirs-lakes/): lake mask; lakes ID points; reservoirs ID points. These maps are required only upon activation of the [lakes module](https://ec-jrc.github.io/lisflood-model/3_02_optLISFLOOD_lakes/) and/or of the [reservoirs module](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). -+ [rice calendar](../4_Static-Maps_rice-calendar/): rice calendar for planting and harvesting seasons. These maps are required only when activating the [rice irrigation module](https://ec-jrc.github.io/lisflood-model/2_17_stdLISFLOOD_irrigation/) ++ [rice calendar](../4_Static-Maps_water-use/): rice calendar for planting and harvesting seasons. These maps are required only when activating the [rice irrigation module](https://ec-jrc.github.io/lisflood-model/2_17_stdLISFLOOD_irrigation/) + inflow points: locations and IDs of the points in which LISFLOOD adds an inflow hydrograph, as explained [here](https://ec-jrc.github.io/lisflood-model/3_09_optLISFLOOD_inflow-hydrograph/) -+ water demand maps: domestic, energetic, livestock, industrial water use. These maps represent the time series of spatially distributed values of water demand for domestic, energetic, livestock, and industrial water use. These maps are required only when activating the [water use module](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) -+ outlet points: locations and IDs of the points for which LISFLOOD provides the time series of discharge values. ++ [sectoral water demand maps]: domestic, energetic, livestock, industrial water use. These maps represent the time series of spatially distributed values of water demand for domestic, energetic, livestock, and industrial water use. These maps are required only when activating the [water use module](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) ++ outlet points: locations and IDs of the points for which OS LISFLOOD provides the time series of discharge values. #### Role of "mask", "channels" ans "channelsMCT" maps -The mask map (i.e. "area.map") defines the model domain. In order to avoid unexpected results, **it is vital that all maps that are related to topography, land use and soil are defined** (i.e. don't contain a missing value) for each pixel that is "true" (has a Boolean 1 value) on the mask map. The same applies for all meteorological input and the Leaf Area Index maps. Similarly, all pixels that are "true" on the channels map must have some valid (non-missing) value on each of the channel parameter maps. At the same time, all pixels that have value "true" in the MCT rivers mask must also belong to the "channels" map. Undefined pixels can lead to unexpected behaviour of the model, output that is full of missing values, loss of mass balance and possibly even model crashes. Some maps needs to have values in a defined range e.g. the gradient map has to be greater than 0. +The mask map (i.e. domain.nc, also called area.nc) defines the model domain. In order to avoid unexpected results, **it is vital that all maps that are related to topography, land use and soil are defined** (i.e. don't contain a missing value) for each pixel that is "true" (has a Boolean 1 value) on the mask map. The same applies for all meteorological input and the Leaf Area Index maps. Similarly, all pixels that are "true" on the channels map must have some valid (non-missing) value on each of the channel parameter maps. At the same time, all pixels that have value "true" in the MCT rivers mask must also belong to the "channels" map. Undefined pixels can lead to unexpected behaviour of the model, output that is full of missing values, loss of mass balance and possibly even model crashes. Some maps needs to have values in a defined range e.g. the gradient map has to be greater than 0. When preparing their own input maps, users are recommended to refer to [these guidelines](../4_Static-Maps-introduction/). #### Geometrical properties of the computational grid cell -LISFLOOD needs to know the size properties of each grid cell (length, area) in order to calculate water *volumes* from meteorological forcing variables that are all defined as water *depths*. By default, LISFLOOD obtains this information from the location attributes of the input maps. This will only work if all maps are in an "equal area" (equiareal) projection, and the map co-ordinates (and cell size) are defined in meters. For datasets that use, for example, a latitude-longitude system, neither of these conditions is met. In such cases you can still run LISFLOOD if you provide two additional maps that contain the length and area of each grid cell +LISFLOOD needs to know the size properties of each grid cell (length, area) in order to calculate water *volumes* from meteorological forcing variables that are all defined as water *depths*. By default, LISFLOOD obtains this information from the location attributes of the input maps. This will only work if all maps are in an "equal area" (equiareal) projection, and the map co-ordinates (and cell size) are defined in meters. For datasets that use a latitude-longitude system, neither of these conditions is met. In such cases it is imperative to provide two additional maps that contain the length and area of each grid cell. These maps are described in [this section](../4_Static-Maps_general-maps/) of the [guidelines](../4_Static-Maps-introduction/) for the generation of the static maps and tables. -##### Table: Optional maps that define grid size +##### Table: maps that define grid size, essential when using latitude-longitude system | **Map** | **Default name** | **Description** | | --------------- | ------------------ | ------------------------------------------------------------ | | PixelLengthUser | pixleng.map/nc | Map with pixel length

Unit: $[m]$,
*Range *of values: map \> 0* | | PixelAreaUser | pixarea.map/nc | Map with pixel area

*Unit:* $[m^2]$,
*Range of values: map \> 0* | -Both maps should be stored in the same directory where all other input maps are. The values on both maps may vary in space. A limitation is that a pixel is always represented as a square, so length and width are considered equal (no rectangles). In order to tell LISFLOOD to use the maps a, you need to activate the special option "*gridSboveizeUserDefined*", which involves adding the following line to the LISFLOOD settings file: +The values on both maps may vary in space. A limitation is that a pixel is always represented as a square, so length and width are considered equal (no rectangles). In order to tell LISFLOOD to use the maps a, you need to activate the special option "*gridSboveizeUserDefined*", which involves adding the following line to the LISFLOOD settings file: ```xml @@ -70,33 +75,21 @@ Because Leaf area index maps follow a yearly circle, only a map stack of one yea #### Important technical note for the generation of the water regions map -Water demand and water abstraction are spatially distributed within each water region. As detailed [here](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/), the water resources (surface water bodies and groundwater) are shared inside the water region in order to meet the cumulative requirements of the water region area. For this reason, it is strongly recommended to include the entire water region(s) in the modelled area. If a portion of the water region is not included in the modelled area, then LISFLOOD cannot adequately compute the water demand and abstraction. In other words, LISFLOOD will not be able to account for sources of water outside of the computational domain (it is important to notice that LISFLOOD will not crush but the results will be affected by this discrepancy). +Water demand and water abstraction are spatially distributed within each water region. As detailed [here](../2_18_stdLISFLOOD_water-use/), the water resources (surface water bodies and groundwater) are shared inside the water region in order to meet the cumulative requirements of the water region area. For this reason, it is strongly recommended to include the entire water region(s) in the modelled area. If a portion of the water region is not included in the modelled area, then LISFLOOD cannot adequately compute the water demand and abstraction. In other words, LISFLOOD will not be able to account for sources of water outside of the computational domain (it is important to notice that LISFLOOD will not crush but the results will be affected by this discrepancy). The inclusion of the complete water region in the computational domain becomes compulsory under the specific circumstances of model calibration. Calibrated parameters are optimised for a specific model set up. It is often required to calibrate the parameters of several subcatchments inside a basin. Each calibration subcatchment must include a finite number of water regions (each water region can belong to only one subctatchment). If this condition is met, the calibrated parameters can be correctly optimised. Conversely, when a water region belongs to one or more calibration sub-catchments, the water resources are allocated and abstracted in different quantities when modelling the calibration subcatchment only or the entire basin. Similarly, the option groundwater smooth leads to different geometries of the cone of depression due to groundwater abstraction when modelling the subcatchment only or the entire basin. These two scenarios impede the correct calibration of the model parameters and must be avoided. The user is advised to switch off the groundwater smooth option and to ensure the consistency between water regions and calibration cacthments. The utility [waterregions](https://github.com/ec-jrc/lisflood-utilities/) can be used to 1) verify the consistency between calibration catchments and water regions or 2) create a water region map which is consistent with a set of calibration points. ### INPUT TABLES -The geographical location of lakes and reservoirs is identified by the two maps described [here](../4_Static-Maps_reservoirs-lakes/). These maps provide the location of lakes and reservoirs. Each lake and each reservoir is identified by its ID (an integer number). LISFLOOD requires additional information for the adequate modelling of [lakes](https://ec-jrc.github.io/lisflood-model/3_02_optLISFLOOD_lakes/) and [reservoirs](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). These additional pieces of information are supplied to the numerical code by using tables in *.txt* format. Each table has 2 columns: the first column is the ID of the lake or of the reservoir, the second column is the quantity required by LISFLOOD. The table below provides the list of the pieces of information which are required for the adequate modelling of lakes and reservoirs. -##### Table: LISFLOOD input tables - -| **Table** | **Default name** | **Description** | -|----------------------------|-----------------------|--------------------------| -| Lake area | Lakearea.txt | Lake surface area in m2 | -| Lake alpha parameter | lakea.txt | Lake parameter alpha: a detailed description can be found [here](https://ec-jrc.github.io/lisflood-model/3_02_optLISFLOOD_lakes/) | -| Lake average inflow | lakeaverageinflow.txt | Average inflow to the lake: a detailed description can be found [here](https://ec-jrc.github.io/lisflood-model/3_02_optLISFLOOD_lakes/) | -| Reservoir storage | rstor.txt | Volume in m3, total reservoirs storage capacity | -| Reservoir minimum outflow | rminq.txt | Discharge in m3/s. | -| Reservoir normal outflow | rnormq.txt | Discharge in m3/s. | -| Reservoir non damaging outflow | rndq.txt | Discharge in m3/s. | -| Reservoir conservative storage value | rclimq.txt |Fraction, typical value: 0.07 | -| Reservoir storage limit in normal flow condition | rnlim.txt |Fraction, typical values: 0.65-0.67 | -| Reservoir storage limit during floods | rflim.txt |Fraction, typical value: 0.97 | - +The geographical location of lakes and reservoirs is identified by the two maps described [here](../4_Static-Maps_reservoirs-lakes/). These maps provide the location of lakes and reservoirs. Each lake and each reservoir is identified by its ID (an integer number). +LISFLOOD requires additional information for the adequate modelling of [lakes](https://ec-jrc.github.io/lisflood-model/3_02_optLISFLOOD_lakes/) and [reservoirs](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). These additional pieces of information are supplied to the numerical code by using tables in *.txt* format. Each table has 2 columns: the first column is the ID of the lake or of the reservoir, the second column is the quantity required by OS LISFLOOD. For example, OS LISFLOOD requires the surface area of each lake, and the storage capacity of each reservoir. The dedicated section [Reservoirs and lakes, maps and table](../4_Static-Maps_reservoirs-lakes/) of the [guidelines](../4_Static-Maps-introduction/) for the generation of the static maps and tables. ### Organisation of input data -It is up to the user how the input data are organised. However, it is advised to keep the base maps, meteorological maps and tables separated (i.e. store them in separate directories). For practical reasons the **following input structure is suggested**: +It is up to the user how the input data are organised. As an example, users might decide to organize base maps, meteorological maps, static maps, and tables in separate directories. It is strogly recommended to store output files in a separate directory. + +For example: - all **base maps** are in one directory (e.g. 'maps') @@ -104,25 +97,17 @@ It is up to the user how the input data are organised. However, it is advised to - soil hydraulic properties in a subfolder (e.g.'soilhyd') - - land cover depending maps in a subfolder (e.g.'table2map') + - water demand maps in a subfolder (e.g. 'waterdemand') + - ...etc - all **tables** are in one directory (e.g. 'tables') - all **meteorological input** maps are in one directory (e.g. 'meteo') -- a folder **Leaf Area Index** (e.g. 'lai') - - - all Leaf Area Index for forest in a subfolder (e.g.'forest') - - - all Leaf Area Index for other in a subfolder (e.g.'other') - - all **output** goes to one directory (e.g. 'out') -The following Figure illustrates this: - -![](../media/image36.png) -***Figure:*** *Suggested file structure for LISFLOOD* +Users might consider the example of sub-folders organization provided in the public datasets: [OS LISLOOD static and parameter maps for GloFAS dataset](https://data.jrc.ec.europa.eu/dataset/68050d73-9c06-499c-a441-dc5053cb0c86) and [OS LISLOOD static and parameter maps for Europe](https://data.jrc.ec.europa.eu/dataset/f572c443-7466-4adf-87aa-c0847a169f23). From 510b387b1baa0dac133aa17b0f20920f4d2d85f9 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 11:16:02 +0200 Subject: [PATCH 38/70] small fix step4_preparing-input-files --- docs/3_step4_preparing-input-files/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/3_step4_preparing-input-files/index.md b/docs/3_step4_preparing-input-files/index.md index 1067b23c..1299f641 100644 --- a/docs/3_step4_preparing-input-files/index.md +++ b/docs/3_step4_preparing-input-files/index.md @@ -4,7 +4,7 @@ In the current version of OS LISFLOOD, all the model inputs are provided as eith ### INPUT MAPS -> Albeit OS LISFLOOD can still read maps in pcraster format, users are strongly recommended to prepare their own input maps in NetCDF format: pcraster format will be discarded in future versions of OS LISFLOOD (timeline not yet defined). +> Albeit OS LISFLOOD can still read maps in pcraster format, users are strongly recommended to prepare their own input maps in NetCDF format: pcraster format will be discarded in future versions of OS LISFLOOD (timeline not yet defined). Users interested in converting their existing pcraster maps into NetCDF format can refer to the [OS LISFLOOD untility pcr2nc](https://github.com/ec-jrc/lisflood-utilities#pcr2nc). LISFLOOD requires that all maps must have *identical* location attributes (number of rows, columns, cellsize, upper x and y coordinates). @@ -32,16 +32,16 @@ Generally used prefixes for the meteorological forcings maps are:
### Static maps The section [Static Maps](../4_Static-Maps-introduction) provides detailed guidelines for the preparation of the static maps data set. The following paragraph provides an overview of the information provided by the static maps. + [general maps](../4_Static-Maps_general-maps/): area mask; landuse mask; grid-cell length; grid-cell area. -+ [topography](../4_Static-Maps_topography/): local drain direction; gradient; standard deviation of elevation; upstream area. -+ [land use maps](../4_Static-Maps_land-use/): fraction of forest; fraction of irrigated crops; fraction of rice crops; fraction of inland water; fraction of sealed surfaces; fraction of other land uses. ++ [topography](../4_Static-Maps_topography/): local drain direction; gradient; standard deviation of elevation; upstream area. ++ [land use maps](../4_Static-Maps_land-use/): fraction of forest; fraction of irrigated crops; fraction of rice crops; fraction of inland water; fraction of sealed surfaces; fraction of other land uses. + [land use depending](../4_Static-Maps_land-use-depending/):crop coefficient; crop group number; Manning/s's surface roughness; soil depth. + [soil hydraulic properties](../4_Static-Maps_soil-hydraulic-properties/): saturated hydraulic conductivity; soil water content at saturation; residual soil water content; parameters alpha and lambda of Van Genuchten's equations. + [channel geometry](../4_Static-Maps_channel-geometry/): channels mask; channels side slope; channels length; channels gradient; Manning's rougheness coefficient of the channels; channels bottom width; floodplain width; bankfull channels depth; MCT diffusive wave routing channels. + [leaf area index](../4_Static-Maps_leaf-area-index/): evolution of vegetation over time (leaf area index) for land covers forest, irrigated areas, others. + [reservoirs and lakes](../4_Static-Maps_reservoirs-lakes/): lake mask; lakes ID points; reservoirs ID points. These maps are required only upon activation of the [lakes module](https://ec-jrc.github.io/lisflood-model/3_02_optLISFLOOD_lakes/) and/or of the [reservoirs module](https://ec-jrc.github.io/lisflood-model/3_03_optLISFLOOD_reservoirs/). -+ [rice calendar](../4_Static-Maps_water-use/): rice calendar for planting and harvesting seasons. These maps are required only when activating the [rice irrigation module](https://ec-jrc.github.io/lisflood-model/2_17_stdLISFLOOD_irrigation/) ++ [rice calendar](../4_Static-Maps_water-use/): rice calendar for planting and harvesting seasons. These maps are required only when activating the [rice irrigation module](https://ec-jrc.github.io/lisflood-model/2_17_stdLISFLOOD_irrigation/) + inflow points: locations and IDs of the points in which LISFLOOD adds an inflow hydrograph, as explained [here](https://ec-jrc.github.io/lisflood-model/3_09_optLISFLOOD_inflow-hydrograph/) -+ [sectoral water demand maps]: domestic, energetic, livestock, industrial water use. These maps represent the time series of spatially distributed values of water demand for domestic, energetic, livestock, and industrial water use. These maps are required only when activating the [water use module](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) ++ [sectoral water demand maps]: domestic, energetic, livestock, industrial water use. These maps represent the time series of spatially distributed values of water demand for domestic, energetic, livestock, and industrial water use. These maps are required only when activating the [water use module](https://ec-jrc.github.io/lisflood-model/2_18_stdLISFLOOD_water-use/) + outlet points: locations and IDs of the points for which OS LISFLOOD provides the time series of discharge values. #### Role of "mask", "channels" ans "channelsMCT" maps From 24ccd4a5e5538d56cb733b5b11379f221a9ac317 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 15:19:00 +0200 Subject: [PATCH 39/70] improvements to step5 model initialization --- docs/3_step5_model-initialisation/index.md | 66 ++++++++++++++-------- 1 file changed, 44 insertions(+), 22 deletions(-) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index 72bda055..0481acd6 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -62,46 +62,68 @@ The complete list of initial state values for a **OS LISFLOOD prerun** is presen - average discharge (when using SplitRouting). -### Initialization of soil moisture content +### Initialization of volumetric soil moisture content -> An improved initialization scheme has been implemented in OS-LISFLOOD v5.0.0, allowing to remove non-realistic trends in soil moisture content and fictitious discharge values in the channels previously observed, for example, in arid climates. Albeit the former initialization strategy with bogus values is still feasibile, the use of the methodology explained here is highly recommended, for all modelling excercises. +> An improved initialization scheme has been implemented in OS-LISFLOOD v5, allowing to remove non-realistic trends in the thrid soil layer volumetric soil moisture content and consequent fictitious discharge values in the channels. There were previously observed, for example, in arid climates. Albeit the former initialization strategy with bogus values is still feasibile, the use of the methodology explained here is highly recommended, for all modelling excercises. -OS LISFLOOD prerun provides in output end states and average fluxes. The end states are the volumetric soil moisture content for the three soil layers and the three land covers (9 maps). The average fluxes represent the average infiltration (over the simulation period) from the soil layer 2 to soil layer 3, for the three land cover fractions (3 maps indicated as *SeepTopToSubBAverageXX*). In the cold run, the end states are used to initialise the volumetric soil moisture content of soil layers 1 and 2. The initialisation of the volumetric soil moisture content of soil layer 3 makes use of the relevant end state and of the fluxes. -Accorind to the steady-state approach, the model tries to enable long term equilibrium conditions between average inflow and outflow fluxes in the third soil layer. +OS LISFLOOD prerun provides in output end states and average fluxes. The end states are the volumetric soil moisture content for the three soil layers and the three land covers (9 maps). The average fluxes represent the average infiltration (over the simulation period) from the soil layer 2 to soil layer 3, for the three land cover fractions (3 maps indicated as *SeepTopToSubBAverageOther/Forest/Irrigated*). In the cold run, the end states are used to initialise the volumetric soil moisture content of soil layers 1 and 2. The initialisation of the volumetric soil moisture content of soil layer 3 makes use of the relevant end state and of the fluxes. +Specifically, according to the steady-state approach, the model tries to enable long term equilibrium conditions between average inflow and outflow fluxes in the third soil layer. +*SeepTopToSubBAverageOther/Forest/Irrigated* is the average inflow to the third soil layer. As explained above, this quantity is computed during the prerun. -ADD EQUATION!!! +$$ +q_{soil2to3,fraction} = SeepTopToSubBAverageFraction +$$ + +The prerun must include a sufficiently long simulation period (a few decades) to allow the computation of representative valuse of *SeepTopToSubBAverageOther/Forest/Irrigated*. Furthermore, accounting for an adequate spin-up period of the prerun allows is recommended to compute realistic average fluxes values. This latter outcome can be achieved by adequately setting the value of *NumDaysSpinUp* (recommended value: 1095 days, i.e. 3 years). + +Within OS LISFLOOD, the outflow from the third soil layer to the upper groundwater zone is defined by the equations explained in the chapter [Soil moisture redistribution](https://ec-jrc.github.io/lisflood-model/2_12_stdLISFLOOD_soilmoisture-redistribution/) of the [Model Documentation](https://ec-jrc.github.io/lisflood-model/). + +$$ +q_{soil3toUZ,fraction} = K_s \cdot \sqrt{( \frac{w - w_r}{w_s - w_r})} \cdot \{ 1 - [ 1 - ( \frac{w -w_r}{w_s - w_r})^\frac{1}{m}]^m\}^2 +$$ + +where $K_s$ is the saturated conductivity of the soil $[\frac{mm}{day}]$; and $w, w_r$ and $w_s$ are the actual, residual and maximum amounts of moisture in the soil respectively (all in $[mm]$); $m$ is a parameter related to the pore-size index. -In more detail, for soil layer 3, the average seepage maps as well as an .end map are produced that later serves as a starting guess for solving the second-order, non-linear Van Genuchten equation. Accounting for an adequate spin-up period of the initialization run allows and is recommended to compute realistic average fluxes values. This latter outcome can be achieved by adequately setting the value of *NumDaysSpinUp*. +The long term equilibrium conditions between average inflow and outflow fluxes requires, for each fraction, within each pixel: + +$$ +SeepTopToSubBAverageFraction = K_s \cdot \sqrt{( \frac{w - w_r}{w_s - w_r})} \cdot \{ 1 - [ 1 - ( \frac{w -w_r}{w_s - w_r})^\frac{1}{m}]^m\}^2 +$$ +The third layer volumetric soil moisture content *steady state storage* value is computed by solving the second-order, non-linear equation above, where $w$ is the only unknown. +Prerun end states of volumetric soil moisture of layer 3 are used as initial guess for the numerical solution of the equation above. -### Initialization of the upper groundwater zone +### Initialization of the upper groundwater zone water content To initialize the upper groudwater zone water content it is recommended to use the end state generated by the prerun.
-### Initialisation of the lower groundwater zone +### Initialisation of the lower groundwater zone water content -The condition in which *the lower groundwater zone storage is constant over time means that the in- and outflow terms balance each other out*. This condition is known as a **steady state situation**, and the constant ‘end’ storage is in fact the *steady state storage*. -The rate of change of the lower zone’s storage at any moment is given by the continuity equation: +According to the steady-state approach, the condition in which *the lower groundwater zone storage is constant over time means that the in- and outflow terms balance each other out*. OS LISFLOOD approach for the computation of inflow, outflow, and storage variation is explained in the chapter [Groudwater](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/) of the [Model Documentation](https://ec-jrc.github.io/lisflood-model/). + +The prerun computes the average net inflow $LZavin$ over the simulation period. For this purpose, the prerun must include a sufficiently long simulation period (a few decades) to achieve representative $LZavin$ values. + +Within OS LISFLOOD, groundwater outflow is computed as: $$ -\frac{dLZ}{dt}=I(t)-O(t) +Q_{lz}=\frac{1}{T_{lz}} \cdot LZ $$ -where $I$ is the inflow (i.e. groundwater recharge) and $O$ is the outflow rate. For a situation where the storage remains constant, we can write: -
$\frac{dLZ}{dt}=0$ only if $I(t)=O(t)$ +$T_{lz}$ is a parameter provided as input to the model or defined by calibration. -This equation can be re-written as: -
$I(t) = \frac{1}{T_{lz}} \cdot LZ$ +The steady state storage $LZ_{ss}$ is then computed internally by the code: + +$$ +\frac{1}{T_{lz}} \cdot LZ = LZ_{avin} +$$ -Solving this for LZ gives the steady state storage: -
$LZ_{ss} = T_{lz} \cdot I(t)$ +$$ +LZ_{ss} = T_{lz} \cdot LZ_{avin} +$$ -T_{lz} is a parameter provided as input to the model. -The OS LISFLOOD preun is used to compute $I(t)$, here defined as the average net inflow to the lower groundwater zone: $LZavin$. -T_{lz} and $LZavin$ allow to obtain LZ *steady state storage* value. -For this purpose, the prerun must include a sufficiently long simulation period (a few decades) to allow the computation of representative values of LZavin. The set-up of the prerun run is explained below; the protocol differs slightly depending on the settings of the split routing option. + The set-up of the prerun run is explained below; the protocol differs slightly depending on the settings of the split routing option. **Table:** LISFLOOD special initialisation methods activated by setting the value of each respective variable to a 'bogus' value of -9999 @@ -123,7 +145,7 @@ For this purpose, the prerun must include a sufficiently long simulation period ### Option 1: If using Kinematic routing only (no split routing): -1) Set initial state of all state variables to either 0,1 or -9999 (i.e. cold start with default values or internally initialised values) in Settings.XML file +1) Set initial state of all state variables to either 0, 1 or -9999 (i.e. cold start with bogus values or internally initialised values) in Settings.XML file 2) Activate the “InitLisfloodwithoutsplit” and the "InitLisflood" options in section of Settings.XML file using: ```xml From cb84f230fa9f01628c7696155fd46659b0de7d3e Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 15:30:29 +0200 Subject: [PATCH 40/70] small fixes step5 --- docs/3_step5_model-initialisation/index.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index 0481acd6..cf15f237 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -2,6 +2,24 @@ Just as any other hydrological model, LISFLOOD needs to know the initial state (i.e. amount of water stored in the groundwater zone, soil, channels) of its internal state variables in order to start a simulation. However, in practice we hardly ever know the initial state of all state variables at a given time. Hence, the state of the initial storages must be estimated: this phase is the initialisation of a hydrological model. +
+ + +

+ +OS LISFLOOD **prerun** simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun constitutes the **initialization run**. OS LISFLOOD prerun output is used as input to the OS LISFLOOD cold start run. + +OS LISFLOOD cold start run and warm start run deliver the actual model outputs to be usef for analysis/forecasts. + +OS LISFLOOD **cold start** run takes as input the OS LISFLOOD prerun output to initialize the slow storages (soil and groundwater). Initial values of fast(er) respoding storages (e.g. channel volume) are set to bogus values. It is always recommended to discard the initial (3) years of the OS LISFLOOD cold start to allow adequate initialization of fast(er) respoding storages. + +OS LISFLOOD **warm start** resumes the computations from the end states of a preceeding simulation. The set-up of this type of simulation is described in the next section of this user guide. +

+

+

 +
+ + >**OS LISFLOOD prerun** simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun constitutes the **initialization run**. OS LISFLOOD prerun output is used as input to the OS LISFLOOD cold start run. From 40f10071e6eb954571003c55eb06338ed6b43368 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 15:31:58 +0200 Subject: [PATCH 41/70] small fixes step5 --- docs/3_step5_model-initialisation/index.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index cf15f237..896f22db 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -2,25 +2,6 @@ Just as any other hydrological model, LISFLOOD needs to know the initial state (i.e. amount of water stored in the groundwater zone, soil, channels) of its internal state variables in order to start a simulation. However, in practice we hardly ever know the initial state of all state variables at a given time. Hence, the state of the initial storages must be estimated: this phase is the initialisation of a hydrological model. -
- - -

- -OS LISFLOOD **prerun** simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun constitutes the **initialization run**. OS LISFLOOD prerun output is used as input to the OS LISFLOOD cold start run. - -OS LISFLOOD cold start run and warm start run deliver the actual model outputs to be usef for analysis/forecasts. - -OS LISFLOOD **cold start** run takes as input the OS LISFLOOD prerun output to initialize the slow storages (soil and groundwater). Initial values of fast(er) respoding storages (e.g. channel volume) are set to bogus values. It is always recommended to discard the initial (3) years of the OS LISFLOOD cold start to allow adequate initialization of fast(er) respoding storages. - -OS LISFLOOD **warm start** resumes the computations from the end states of a preceeding simulation. The set-up of this type of simulation is described in the next section of this user guide. -

-

-

 -
- - - >**OS LISFLOOD prerun** simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun constitutes the **initialization run**. OS LISFLOOD prerun output is used as input to the OS LISFLOOD cold start run. >OS LISFLOOD cold start run and warm start run deliver the actual model outputs to be usef for analysis/forecasts. From 31df3f6f828fe5a9182ac126a7537881e4fc899b Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 15:46:53 +0200 Subject: [PATCH 42/70] improvements to step5 model initialization --- docs/3_step5_model-initialisation/index.md | 266 +++++++++++---------- 1 file changed, 135 insertions(+), 131 deletions(-) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index 896f22db..b6f76837 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -15,8 +15,9 @@ In this page we will: 1. demonstrate the effect of the model's initial states on simulation results 2. explain the theory of initialisation and the steady-state storage concept 3. explain how to run the pre-run (initialization) for kinematic (kinematic and diffusive) and split routing (split routing and diffusive) routing configurations - 4. describe how to use the pre-run outputs to set up a cold start - 5. describe how to complete the initialisation in temporal chunks when needed + 4. describe how to complete the initialisation in temporal chunks when needed + 5. describe how to use the pre-run outputs to set up a cold start + ## The impact of the model initial state on simulation results @@ -51,7 +52,10 @@ A similar reasoning applies to the soil water content of the third soil layer. Spurious trends in the soil layers and in the lower groundwater zone will obviously lead to spurious trends in the baseflow simulations. Consequently, to avoid unrealistic trends in the simulations, very long spin-up periods may be needed, thus requiring a large amount of computational and time resources. -To by-pass the need for excessively long spin-up periods, LISFLOOD is capable of calculating a *steady-state* storage amount for the third soil layer and for the lower groundwater zone. This *steady state* storage, introduced in this [chapter](https://ec-jrc.github.io/lisflood-model/2_13_stdLISFLOOD_groundwater/), is very effective for reducing spin-up time. +To by-pass the need for excessively long spin-up periods, LISFLOOD is capable of calculating a *steady-state* storage amount for the third soil layer and for the lower groundwater zone. + + +## The theory of initialisation and the steady-state storage concept The following paragraphs explain how the analytical solutions can be used to leverage on the **outputs of a OS LISFLOOD prerun** to adequately initialize volumetric soil moisture content and lower groundwater zone water content of a **OS LISFLOOD cold start**. @@ -140,7 +144,7 @@ $$ -## 4.3 What you need to do: +## Set-up of a LISFLOOD prerun ### Option 1: If using Kinematic routing only (no split routing): @@ -270,134 +274,8 @@ Similarly, set the name of the reporting map for the end states in sect ``` -## 4.4 After the initialization: setting up the cold start model run - - -i) Checking the lower zone initialisation - -The presence of any initialisation problems of the lower zone can be checked by adding the following line to the ‘lfoptions’ element of the settings file: - -```xml - -``` - -This tells the model to write the values of all state variables (averages, upstream of contributing area to each gauge) to time series files. The default name of the lower zone time series is ‘lzUps.tss’. - - - -![initLZDemo](../media/image40.png) - -***Figure:*** *Initialisation of lower groundwater zone with and without using a pre-run. Note the strong decreasing trend in the simulation without pre-run.* - - - - -ii) The prerun will then create a number (from 1 to 17, depending on the .xml settings) of maps in NetCDF format. Copy those maps (found in folder "out", see the setting $(PathOut) above) into the folder "init" ($(PathInit)) - -The following list enumerates the files required for the correct execution of the LISFLOOD Cold Start: - - * lzavin.nc (strictly required) - - * avgdis.nc (strictly required, but only when using SplitRouting) - - * uz.end.nc, groundwater upper zone water content - other land cover fraction (strongly recommended) - - * uzf.end.nc, groundwater upper zone water content - forest land cover fraction (strongly recommended) - - * uzi.end.nc, groundwater upper zone water content - irrigation land cover fraction (strongly recommended) - - * th1.end.nc, soil moisture - other land cover fraction - first layer (strongly recommended) - - * th2.end.nc, soil moisture - other land cover fraction - second layer (strongly recommended) - - * th3.end.nc, soil moisture - other land cover fraction - third layer (strongly recommended) - - * thf1.end.nc, soil moisture - forest land cover fraction - first layer (strongly recommended) - - * thf2.end.nc, soil moisture - forest land cover fraction - second layer (strongly recommended) - - * thf3.end.nc, soil moisture - forest land cover fraction - third layer (strongly recommended) - - * thi1.end.nc, soil moisture - irrigation land cover fraction - first layer (strongly recommended) - - * thi2.end.nc, soil moisture - irrigation land cover fraction - second layer (strongly recommended) - - * thi3.end.nc, soil moisture - irrigation land cover fraction - third layer (strongly recommended) - - * SeepTopToSubBAverageOtherMap.nc, average flux from second to third soil layer - other land cover fraction (strongly recommended) - - * SeepTopToSubBAverageForestMap.nc, average flux from second to third soil layer - forest land cover fraction (strongly recommended) - - * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction (strongly recommended) - -With strongly recommended we mean that the produced .end maps of the initialization run are used as start values of the model run (cold start). - -```xml -************************************************************** -INITIAL CONDITIONS FOR THE WATER BALANCE MODEL -(can be either maps or single values) -************************************************************** - - - - -$(PathInit)/lzavin.map -Reported map of average percolation rate from upper to -lower groundwater zone (reported for end of simulation) - - - - - -$(PathInit)/avgdis.map -CHANNEL split routing in two lines -Average discharge map [m3/s] - - - - - - - -************************************************************** -INITIAL CONDITIONS OTHER/FOREST/IRRIGATION -(maps or single values) -************************************************************** - - - - - - - - - - - - - - - - -``` - -iii) launch LISFLOOD - -To run the model, start up a command prompt (Windows) or a console window (Linux) and type 'lisflood' followed by the name of the settings file, e.g.: - -```unix -lisflood settings.xml -``` - - -> Important note: -> - Calibration parameters obtained with no split routing should never be used to run simulations with split routing and vice versa. -> - Using option InitLisfloodwithoutsplit=1 will result in an AvgDis file with zero values everywhere. -> - In case of doubts, check content of AvgDis file: if it's all zero, then split routing must be off. Note that an AvgDis file containing all zero values will automatically set LISFLOOD to no split routing, even if SplitRouting=1. - - -## 4.5 Running the initialisation in temporal chunks +## Set-up of a LISFLOOD prerun in temporal chunks Due to specific settings of the computational infrastructure (e.g. timewall that limits the maximum duration of a job), it might be necessary to complete the LISFLOOD initialization in chunks. @@ -640,3 +518,129 @@ These outputs are: * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction + + +## Set-up of the cold start model run + + +i) Checking the lower zone initialisation + +The presence of any initialisation problems of the lower zone can be checked by adding the following line to the ‘lfoptions’ element of the settings file: + +```xml + +``` + +This tells the model to write the values of all state variables (averages, upstream of contributing area to each gauge) to time series files. The default name of the lower zone time series is ‘lzUps.tss’. + + + +![initLZDemo](../media/image40.png) + +***Figure:*** *Initialisation of lower groundwater zone with and without using a pre-run. Note the strong decreasing trend in the simulation without pre-run.* + + + + +ii) The prerun will then create a number (from 1 to 17, depending on the .xml settings) of maps in NetCDF format. Copy those maps (found in folder "out", see the setting $(PathOut) above) into the folder "init" ($(PathInit)) + +The following list enumerates the files required for the correct execution of the LISFLOOD Cold Start: + + * lzavin.nc (strictly required) + + * avgdis.nc (strictly required, but only when using SplitRouting) + + * uz.end.nc, groundwater upper zone water content - other land cover fraction (strongly recommended) + + * uzf.end.nc, groundwater upper zone water content - forest land cover fraction (strongly recommended) + + * uzi.end.nc, groundwater upper zone water content - irrigation land cover fraction (strongly recommended) + + * th1.end.nc, soil moisture - other land cover fraction - first layer (strongly recommended) + + * th2.end.nc, soil moisture - other land cover fraction - second layer (strongly recommended) + + * th3.end.nc, soil moisture - other land cover fraction - third layer (strongly recommended) + + * thf1.end.nc, soil moisture - forest land cover fraction - first layer (strongly recommended) + + * thf2.end.nc, soil moisture - forest land cover fraction - second layer (strongly recommended) + + * thf3.end.nc, soil moisture - forest land cover fraction - third layer (strongly recommended) + + * thi1.end.nc, soil moisture - irrigation land cover fraction - first layer (strongly recommended) + + * thi2.end.nc, soil moisture - irrigation land cover fraction - second layer (strongly recommended) + + * thi3.end.nc, soil moisture - irrigation land cover fraction - third layer (strongly recommended) + + * SeepTopToSubBAverageOtherMap.nc, average flux from second to third soil layer - other land cover fraction (strongly recommended) + + * SeepTopToSubBAverageForestMap.nc, average flux from second to third soil layer - forest land cover fraction (strongly recommended) + + * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction (strongly recommended) + +With strongly recommended we mean that the produced .end maps of the initialization run are used as start values of the model run (cold start). + +```xml +************************************************************** +INITIAL CONDITIONS FOR THE WATER BALANCE MODEL +(can be either maps or single values) +************************************************************** + + + + +$(PathInit)/lzavin.map +Reported map of average percolation rate from upper to +lower groundwater zone (reported for end of simulation) + + + + + +$(PathInit)/avgdis.map +CHANNEL split routing in two lines +Average discharge map [m3/s] + + + + + + + +************************************************************** +INITIAL CONDITIONS OTHER/FOREST/IRRIGATION +(maps or single values) +************************************************************** + + + + + + + + + + + + + + + + +``` + +iii) launch LISFLOOD + +To run the model, start up a command prompt (Windows) or a console window (Linux) and type 'lisflood' followed by the name of the settings file, e.g.: + +```unix +lisflood settings.xml +``` + + +> Important note: +> - Calibration parameters obtained with no split routing should never be used to run simulations with split routing and vice versa. +> - Using option InitLisfloodwithoutsplit=1 will result in an AvgDis file with zero values everywhere. +> - In case of doubts, check content of AvgDis file: if it's all zero, then split routing must be off. Note that an AvgDis file containing all zero values will automatically set LISFLOOD to no split routing, even if SplitRouting=1. From 9f78b86df6da9c6c4cb409663aa8a53ca564a69a Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 15:52:30 +0200 Subject: [PATCH 43/70] improvements to step5 model initialization --- docs/3_step5_model-initialisation/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index b6f76837..6ad2c603 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -12,11 +12,11 @@ Just as any other hydrological model, LISFLOOD needs to know the initial state ( In this page we will: - 1. demonstrate the effect of the model's initial states on simulation results - 2. explain the theory of initialisation and the steady-state storage concept - 3. explain how to run the pre-run (initialization) for kinematic (kinematic and diffusive) and split routing (split routing and diffusive) routing configurations - 4. describe how to complete the initialisation in temporal chunks when needed - 5. describe how to use the pre-run outputs to set up a cold start + 1. [demonstrate the effect of the model's initial states on simulation results](../3_step5_model-initialisation/index.md#the-impact-of-the-model-initial-state-on-simulation-results) + 2. [explain the theory of initialisation and the steady-state storage concept](../3_step5_model-initialisation/index.md#the-theory-of-initialisation-and-the-steady-state-storage-concept) + 3. [explain how to run the pre-run (initialization) for kinematic (kinematic and diffusive) and split routing (split routing and diffusive) routing configurations](../3_step5_model-initialisation/index.md#set-up-of-a-lisflood-prerun) + 4. [describe how to complete the initialisation in temporal chunks when needed](../3_step5_model-initialisation/index.md#set-up-of-a-lisflood-prerun-in-temporal-chunks) + 5. [describe how to use the pre-run outputs to set up a cold start](../3_step5_model-initialisation/index.md#set-up-of-the-cold-start-model-run) ## The impact of the model initial state on simulation results From 1e17f3175174bf11ea8fc6aca3c96b0807b0af98 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 18:32:27 +0200 Subject: [PATCH 44/70] improvements to step5 and step6: describe cold and warm start in step6 --- docs/3_step5_model-initialisation/index.md | 158 ++------------------ docs/3_step6_running-LISFLOOD/index.md | 166 +++++++++++++++++++-- 2 files changed, 166 insertions(+), 158 deletions(-) diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step5_model-initialisation/index.md index 6ad2c603..35bed0d0 100644 --- a/docs/3_step5_model-initialisation/index.md +++ b/docs/3_step5_model-initialisation/index.md @@ -1,14 +1,16 @@ -# Step 4: Initialisation & cold start of LISFLOOD +# Step 4: LISFLOOD initializion or prerun Just as any other hydrological model, LISFLOOD needs to know the initial state (i.e. amount of water stored in the groundwater zone, soil, channels) of its internal state variables in order to start a simulation. However, in practice we hardly ever know the initial state of all state variables at a given time. Hence, the state of the initial storages must be estimated: this phase is the initialisation of a hydrological model. +A OS LISFLOOD simulation requires at least a prerun and a cold start. In some cases, performing warm start simulations might be convenient. The types of OS LISFLOOD runs are explained below. This page focuses on the OS LISFLOOD prerun, the next page is dedicated to the cold start and the warm start. + >**OS LISFLOOD prerun** simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun constitutes the **initialization run**. OS LISFLOOD prerun output is used as input to the OS LISFLOOD cold start run. >OS LISFLOOD cold start run and warm start run deliver the actual model outputs to be usef for analysis/forecasts. >**OS LISFLOOD cold start** run takes as input the OS LISFLOOD prerun output to initialize the slow storages (soil and groundwater). Initial values of fast(er) respoding storages (e.g. channel volume) are set to bogus values. It is always recommended to discard the initial (3) years of the OS LISFLOOD cold start to allow adequate initialization of fast(er) respoding storages. ->**OS LISFLOOD warm start** resumes the computations from the end states of a preceeding simulation. The set-up of this type of simulation is described in the next section of this user guide. +>**OS LISFLOOD warm start** resumes the computations from the end states of a preceeding simulation. In this page we will: @@ -16,7 +18,7 @@ In this page we will: 2. [explain the theory of initialisation and the steady-state storage concept](../3_step5_model-initialisation/index.md#the-theory-of-initialisation-and-the-steady-state-storage-concept) 3. [explain how to run the pre-run (initialization) for kinematic (kinematic and diffusive) and split routing (split routing and diffusive) routing configurations](../3_step5_model-initialisation/index.md#set-up-of-a-lisflood-prerun) 4. [describe how to complete the initialisation in temporal chunks when needed](../3_step5_model-initialisation/index.md#set-up-of-a-lisflood-prerun-in-temporal-chunks) - 5. [describe how to use the pre-run outputs to set up a cold start](../3_step5_model-initialisation/index.md#set-up-of-the-cold-start-model-run) + ## The impact of the model initial state on simulation results @@ -144,7 +146,7 @@ $$ -## Set-up of a LISFLOOD prerun +## Setting-up of a LISFLOOD prerun ### Option 1: If using Kinematic routing only (no split routing): @@ -205,13 +207,6 @@ Similarly, set the name of the reporting map for the end states in sect ``` 6) Run the model for a long period (best for the whole modelling period) -7) Go back to the LISFLOOD settings file, and set the InitLisfloodwithoutsplit to inactive, leaving all other switches as before: - -```xml - - - ``` -7) Run the model for a longer period (if possible more than 3 years, best for the whole modelling period) +7) Run the model for a long period (best for the whole modelling period) -8) Go back to the LISFLOOD settings file, and set the InitLisflood inactive, leaving all other switches as before: -```xml - - - -``` - -This tells the model to write the values of all state variables (averages, upstream of contributing area to each gauge) to time series files. The default name of the lower zone time series is ‘lzUps.tss’. - - - -![initLZDemo](../media/image40.png) - -***Figure:*** *Initialisation of lower groundwater zone with and without using a pre-run. Note the strong decreasing trend in the simulation without pre-run.* - - - - -ii) The prerun will then create a number (from 1 to 17, depending on the .xml settings) of maps in NetCDF format. Copy those maps (found in folder "out", see the setting $(PathOut) above) into the folder "init" ($(PathInit)) - -The following list enumerates the files required for the correct execution of the LISFLOOD Cold Start: - - * lzavin.nc (strictly required) - - * avgdis.nc (strictly required, but only when using SplitRouting) - - * uz.end.nc, groundwater upper zone water content - other land cover fraction (strongly recommended) - - * uzf.end.nc, groundwater upper zone water content - forest land cover fraction (strongly recommended) - - * uzi.end.nc, groundwater upper zone water content - irrigation land cover fraction (strongly recommended) - - * th1.end.nc, soil moisture - other land cover fraction - first layer (strongly recommended) - - * th2.end.nc, soil moisture - other land cover fraction - second layer (strongly recommended) - - * th3.end.nc, soil moisture - other land cover fraction - third layer (strongly recommended) - - * thf1.end.nc, soil moisture - forest land cover fraction - first layer (strongly recommended) - - * thf2.end.nc, soil moisture - forest land cover fraction - second layer (strongly recommended) - - * thf3.end.nc, soil moisture - forest land cover fraction - third layer (strongly recommended) - - * thi1.end.nc, soil moisture - irrigation land cover fraction - first layer (strongly recommended) - - * thi2.end.nc, soil moisture - irrigation land cover fraction - second layer (strongly recommended) - - * thi3.end.nc, soil moisture - irrigation land cover fraction - third layer (strongly recommended) - - * SeepTopToSubBAverageOtherMap.nc, average flux from second to third soil layer - other land cover fraction (strongly recommended) - - * SeepTopToSubBAverageForestMap.nc, average flux from second to third soil layer - forest land cover fraction (strongly recommended) - - * SeepTopToSubBAverageIrrigationMap.nc, average flux from second to third soil layer - irrigation land cover fraction (strongly recommended) - -With strongly recommended we mean that the produced .end maps of the initialization run are used as start values of the model run (cold start). - -```xml -************************************************************** -INITIAL CONDITIONS FOR THE WATER BALANCE MODEL -(can be either maps or single values) -************************************************************** - - - - -$(PathInit)/lzavin.map -Reported map of average percolation rate from upper to -lower groundwater zone (reported for end of simulation) - - - - - -$(PathInit)/avgdis.map -CHANNEL split routing in two lines -Average discharge map [m3/s] - - - - - - - -************************************************************** -INITIAL CONDITIONS OTHER/FOREST/IRRIGATION -(maps or single values) -************************************************************** - - - - - - - - - - - - - - - - -``` - -iii) launch LISFLOOD - -To run the model, start up a command prompt (Windows) or a console window (Linux) and type 'lisflood' followed by the name of the settings file, e.g.: - -```unix -lisflood settings.xml -``` - - -> Important note: -> - Calibration parameters obtained with no split routing should never be used to run simulations with split routing and vice versa. -> - Using option InitLisfloodwithoutsplit=1 will result in an AvgDis file with zero values everywhere. -> - In case of doubts, check content of AvgDis file: if it's all zero, then split routing must be off. Note that an AvgDis file containing all zero values will automatically set LISFLOOD to no split routing, even if SplitRouting=1. diff --git a/docs/3_step6_running-LISFLOOD/index.md b/docs/3_step6_running-LISFLOOD/index.md index 3a880960..176efb7e 100644 --- a/docs/3_step6_running-LISFLOOD/index.md +++ b/docs/3_step6_running-LISFLOOD/index.md @@ -1,19 +1,164 @@ -# Step 5: Running LISFLOOD (warm start) +# Step 5: Running LISFLOOD: cold start and warm start -Once you have initialized LISFLOOD you can launch a "warm start". That means you can use all internal state variables ('end maps') that you have received during the initialization (see Step 4) as the initial conditions for a succeeding simulation. -This is particularly useful if you are simulating individual flood events on a small time interval (e.g. hourly). For instance, to estimate the initial conditions just before the flood event you can do an initialization also called 'pre-run' on a *daily* time interval for the year before the flood event. Then you can use the resulting 'end maps' as the initial conditions for the hourly simulation of the flood event. +> **!Reminder!** Types of OS LISFLOOD model runs and their purpose: -In any case, you should be aware that values of some **internal state variables of the model** (especially lower zone storage) **are very much dependent on the parameterisation used**. Hence, suppose we have 'end maps' that were created using some parameterisation of the model (let's say parameter set *A*), then these maps should **not** be used as initial conditions for a model run with another parameterisation (parameter set *B*). If you decide to do this anyway, you are likely to encounter serious initialisation problems (but these may not be immediately visible in the output!). If you do this while calibrating the model (i.e. parameter set *B* is the calibration set), this will render the calibration exercise pretty much useless (since the output is the result of a mix of different parameter sets). However, for *FrostIndexInitValue* and *DSLRInitValue* it is perfectly safe to use the 'end maps', since the values of these maps do not depend on any calibration parameters (that is, only if you do not calibrate on any of the frost-related parameters!). If you need to calibrate for individual events (i.e.hourly), you should apply *each* parameterisation on *both * the (daily) pre-run and the 'event' run! This may seem awkward, but there is no way of getting around this (except from avoiding event-based calibration at all, which may be a good idea anyway). +>**OS LISFLOOD prerun** simulation has the purpose to adequately initialize the state of the slow storages, namely grounwater zone and soil. OS LISFLOOD prerun constitutes the **initialization run**. OS LISFLOOD prerun output is used as input to the OS LISFLOOD cold start run. -## What you need to do -1) Save and use state/end maps +>OS LISFLOOD cold start run and warm start run deliver the actual model outputs to be usef for analysis/forecasts. -At the end of each model run, LISFLOOD writes maps of all internal state variables. Two different sets of maps can be stored (both sets can be saved at the same time): +>**OS LISFLOOD cold start** run takes as input the OS LISFLOOD prerun output to initialize the slow storages (soil and groundwater). Initial values of fast(er) respoding storages (e.g. channel volume) are set to bogus values. It is always recommended to discard the initial (3) years of the OS LISFLOOD cold start to allow adequate initialization of fast(er) respoding storages. + +>**OS LISFLOOD warm start** resumes the computations from the end states of a preceeding simulation. + +## Setting-up a OS LISFLOOD cold start simulation + +Running a OS LISFLOOD cold start simulation requires the following settings: + +```xml + + + + + + +$(PathInit)/lzavin.map +Reported map of average percolation rate from upper to +lower groundwater zone (reported for end of simulation) + + + + + +$(PathInit)/avgdis.map +CHANNEL split routing in two lines +Average discharge map [m3/s] + + + + + + + +************************************************************** +INITIAL CONDITIONS OTHER/FOREST/IRRIGATION +(maps or single values) +************************************************************** + + + + + + + + + + + + + + + + +``` + +>Users must be aware that values of internal state variables of the model** (especially lower zone storage) strongly dependent on the parameterisation used. Hence, suppose we have 'end maps' and 'average flux maps' that were created using parameter set *A*, then these maps should **not** be used as initial conditions for a model run with a different parameter set *B*. Mixing parameter sets will likely lead to serious initialisation problems (but these may not be immediately visible in the output!). + + +### Verify the correct exectution of model initialization + +Before proceeding to analyse the fluxes and states of interest (e.g. discharge, soil moisture, reservoir storage), it is strongly recommended to carefully verify the successful execution of model states initialization. A non correct initialization is likely to result in spurious trends in soil moisture, groundwater, and river flow variables. + +The presence of any initialisation problems of the lower groundwater zone and of the volumetric soil moisture content can be checked by adding the following line to the ‘lfoptions’ element of the settings file: + +```xml + +``` + +This tells the model to write the values of all state variables (averages, upstream of contributing area to each gauge) to time series files. +The default name of the time series of lower groundwater zone water content is ‘lzUps.tss’. +The default name of the time series of volumetric soil moisture content for layers 1, 2, 3 are 'th1AvUps.tss', 'th2AvUps.tss', 'th3AvUps.tss'. +Users are encouraged to plot the time series and verify the absence of temporal trends. + +![initLZDemo](../media/image40.png) + +***Figure:*** *Initialisation of lower groundwater zone with and without using a pre-run. Note the strong decreasing trend in the simulation without pre-run.* + +### Cold start spin-up period, simulation length + +OS LISFLOOD prerun is devoted to the initialization of the slow storages (volumetric soil moisture content, groudwater water content). + +Within the cold start simulation, an adequate spin-up period allows the adequate initialization of fast(er) storages such as channels water volume. The length of the spin-up period can be indentified empirically by the user as it depends on catchments morphological and climatological features. Experiments based on the global and european model set-ups suggest a spin-up period of 3 years. For example, the OS LISFLOOD cold start of a study aiming to analyse hydrological states and fluxes conditions from 02/01/2000 00:00 should have simulation start date 02/01/1997 00:00 (OS LISFLOOD output results from 02/01/1997 00:00 to 02/01/2000 00:00 will be discarded). As a reminder, the duration of the prerun should cover at least a few decades to enable the computation of reliable average values. + +Depending on the available computational resources and on the purpose of the modelling excercise, the cold start simulation can cover the entire period of interest (i.e. the end step of the cold start can be the last time step for which OS LISFLOOD output results are needed). + +Conversely, where the required duration of the simulation exceeded the available computational resources (e.g. timewall of computational facilities), or in case of specific applications such as forecast generation, data assimilation studies, or in-deppth analysis of specific flood events (within a long term simulation), the sequence cold start and warm start is required. + + +## Setting-up a OS LISFLOOD warm start simulation + +OS LISFLOOD "warm start" simulation resumes the computations from the end point of a cold start simulation (or of a warm start simulation focusing on a preceeding period). The warm start uses all internal state variables ('end maps') generated by the preceeding run as initial conditions. + +>Reminder: prerun, cold start, and warm start simulations must always share the same set of parameters. + +At the end of each model run, LISFLOOD writes maps of all internal state variables: the complete list of state variables is provided in [this Annex](../4_annex_state-variables). Two different sets of maps can be stored (simultaneously, in the output folder): - End maps: NetCDF single maps containing internal state variables values for the last simulation timestep (*StepEnd*) - State maps: NetCDF stack maps containing internal state variables values for the *ReportSteps* period -You can use either state maps or end maps as the initial conditions for a succeeding simulation. This is particularly useful if you are simulating individual flood events on a small time interval (e.g. hourly). For instance, to estimate the initial conditions just before the flood you can do a ‘pre-run’ on a daily time interval for the year before the flood. You can then use the ‘end maps’ as the initial conditions for the hourly simulation. +You can use either state maps or end maps as the initial conditions for a succeeding simulation. - **Saving end maps** To save end maps to be used for later model runs, activate the "repEndMaps" option in section of Settings.XML: @@ -27,14 +172,13 @@ You can use either state maps or end maps as the initial conditions for a succee ``` -Some internal state variables of the model (especially lower zone storage) are very much dependent on the parametrisation used. Hence, suppose we have ‘end maps’ that were created using some parametrisation of the model (let’s say parameter set A), then these maps should not be used as initial conditions for a model run with another parametrisation (parameter set B). 2) **Using state/end maps** LISFLOOD warm start is managed by two keys in Settings XML file: - "StepStart" which is the first output step/date from LISFLOOD model (forecast); -- "timestepInit" which is the step/date to use as the initial state (usually it's one model step before "StepStart", but it can be any date/step). +- "timestepInit" which is the step/date to use as the initial state (one model step before "StepStart"). 3) Two different settings are used to **warm start LISFLOOD** if using dates in Settings XML file; or if using steps numbers in Settings XML file: @@ -46,8 +190,6 @@ LISFLOOD warm start is managed by two keys in Settings XML file: timestepInit= timestamp of the step just before first model output (forecast) (i.e. 2015-01-10 06:00) - When LISFLOOD is reading "StepStart" and "timestepInit" as timestamps, CalendarDayStart is not used to set model start (forecast) or to set the state values to be used to warm start LISFLOOD model, so any date can be used. CalendarDayStart date must be equal to "StepStart" date or precedent. CalendarDayStart date will be used as time_unit in NetCDF files. - If "CalendarDayStart" is set to 2015-01-10 12:00 and "StepStart" is set to 2015-01-10 12:00, the first output of the model will be marked 2015-01-10 12:00 and all netCDF state files will be stored using CalendarDayStart as time_unit with "time" array starting with [0]. To warm start LISFLOOD for a 6-hourly simulation with first output on 2015-01-10 12:00, state variables values for 2015-01-10 06:00 must be used to initialize the model, so "timestepInit" must be set to 2015-01-10 06:00. From 3af780f3e7b08cdc2ecb2f264f6d262925e8f1ac Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 30 Apr 2026 18:48:49 +0200 Subject: [PATCH 45/70] small corrections to 3_step6_model-output --- docs/3_step6_model-output/index.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/docs/3_step6_model-output/index.md b/docs/3_step6_model-output/index.md index 20d893d2..63293f4e 100644 --- a/docs/3_step6_model-output/index.md +++ b/docs/3_step6_model-output/index.md @@ -1,21 +1,25 @@ # Step 6: Default LISFLOOD output LISFLOOD can generate a wide variety of output. Output is generated as either maps or time series (netCDF format, which can be visualised with any netCDF viewer e.g. [Panoply](https://www.giss.nasa.gov/tools/panoply/download/)). -Reporting of output files can be switched on and off using options in the LISFLOOD settings file. For instance, maps of **discharge** at each time step are generated by using the option *repDischargeMaps=1*. Time series of discharge values are generate by activating the option *repDischargeTs=1* +Reporting of output files can be switched on and off using options in the LISFLOOD settings file. + +For instance, maps of **discharge** at each time step are generated by using the option *repDischargeMaps=1*. Time series of discharge values are generate by activating the option *repDischargeTs=1* A number of output files are specific to optional modules, such as the simulation of reservoirs. +The users can manage the steps reported in the output maps via the 'ReportSteps' key of the settings .xml file: the list of options and the relevant instructions can be found [here](../3_step3_preparing-setting-file/index.md#time-related-constants). + **State maps** Output state maps are reported when switching on the option *repStateMaps=1* (note that the file names can always be changed by the user, although this is not recommended). These maps can be used to define the initial conditions of a succeeding simulation.  A full list of state maps can be found [here](../4_annex_state-variables) -To speed up the pre-run, with ‘InitLisflood’ = 1 the output is limited to the maps lzavin, avgdis, and (optionally) the end maps of the states listed [here](../3_step5_model-initialisation) +To speed up the pre-run, with ‘InitLisflood’ = 1 the output is limited to the maps required for the initialization of the cold start or when performing the prerun in temporal chunks. **Other output maps** -This paragraph provide examples of output maps that are not included in the repStateMaps but can be of interest to many users: +This paragraph provides examples of output maps that are not included in the repStateMaps but can be of interest to many users: 1. Maps of **discharge**; reporting of these maps can be activated using the option *repDischargeMaps=1* @@ -25,24 +29,17 @@ This paragraph provide examples of output maps that are not included in the repS 4. **Seepage** maps, that is flow from the third soil layer to the upper groundwater zone can be activated using the option *repSeepSubToGWMaps=1* -5. Maps of the **water volume abstracted from surface water bodies to satisfy anthropogenic use** can be activated using the option *repTotalAbs=1* **Time series** Time series file have *.tss* extension and they can be opened with any text editor. These files are organized in a number of columns. Specifically, the first column shows the timestep and the other columns show the values of the selected output variable for each gauge or site. Gauges and sites locations must be defined by the users in the settings file. -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 (examples are soil moisture and lower groundwater storage), averaged over area upstream of each gauge location**; reporting of these time series can be activated using the option *repStateUpsGauges=1* +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* -5. Time series with values of **model rate variables (examples are the outflow from the upper and lower groundwater zones to the channels; the vertical seepage and percolation flows), averaged over area upstream of each gauge location**; reporting of these time series can be activated using the option *repRateUpsGauges=1* +2. Time series with values of **model state variables (examples are soil moisture and lower groundwater storage), averaged over area upstream of each gauge location**; reporting of these time series can be activated using the option *repStateUpsGauges=1* -6. Time series that are specific to other **options** (e.g. simulation of reservoirs). +3. Time series with values of **model rate variables (examples are the outflow from the upper and lower groundwater zones to the channels; the vertical seepage and percolation flows), averaged over area upstream of each gauge location**; reporting of these time series can be activated using the option *repRateUpsGauges=1* -> Note that the options *repStateUpsGauges*, *repRateUpsGauges* and *repDischargeMaps* tend to slow down the execution of the model quite dramatically. For applications of the model where performance is critical (e.g. automated calibration runs), we advise to keep them switched off, if possible. +4. Time series that are specific to other **options** (e.g. simulation of reservoirs). It is important to be aware of the spatial domain for which each time series is computed. For instance, 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. From b88cea1d9bf9e34ad89b5b540097d4d51f4a161d Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Mon, 11 May 2026 18:06:37 +0200 Subject: [PATCH 46/70] improve title model installation --- docs/3_step2_installation/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/3_step2_installation/index.md b/docs/3_step2_installation/index.md index 494b7a87..50dbdfa6 100644 --- a/docs/3_step2_installation/index.md +++ b/docs/3_step2_installation/index.md @@ -1,4 +1,4 @@ -## Step 1: Installation of the LISFLOOD model +## How to install OS LISFLOOD There are several ways to get lisflood model and to run it on your machines: From 364d47015764f1131037b70d95bd1748a22de0e1 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Mon, 11 May 2026 18:53:05 +0200 Subject: [PATCH 47/70] re-organize ESSENTIAL info --- docs/2_ESSENTIAL_time-management/index.md | 82 +++++++++++++++++++++-- 1 file changed, 76 insertions(+), 6 deletions(-) diff --git a/docs/2_ESSENTIAL_time-management/index.md b/docs/2_ESSENTIAL_time-management/index.md index 17d46fcb..c6d84961 100644 --- a/docs/2_ESSENTIAL_time-management/index.md +++ b/docs/2_ESSENTIAL_time-management/index.md @@ -1,6 +1,76 @@ -# Time management (start, end, re-start simulations) +# Essential concepts -## Time convention within LISFLOOD model +This page presents: +- an overview of the required files and folders +- an overview of the OS LISFLOOD Settings.xml file (the main and essential argument of OS LISFLOOD command line) +- the time convention within lisflood, understanding of the latter is **essential for a correct model set-up**. + +## What is needed to run a OS LISFLOOD model? + +In order the run a simulation you will need: + + - Meteo input maps + - Static input maps + - Tables, only in case specific features such as reservoirs and lakes are included in the modeling excercis + - An empty output directory where all model data can be written + - OS LISFLOOD settings file in .xml format + +The section [Input files](../3_step4_preparing-input-files) provides a detailed description of input maps and tables. + +The settings file (settings.xml) allows the selection of input maps, modelling options, and output variables and storage folder. The settings .xml is the essential argument of OS LISFLOOD command line. The section below presents its main components, an in depth descrition is provided in the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/). + + +## OS LISFLOOD settings file (settings.xml) + + +All input files, output files, and parameter specifications are defined in a settings file. This file links variables and parameters in the model to in- and output files (maps, time series, tables) and numerical values. Moreover, the settings file can be used to specify the various model *options*. The settings file has a special (XML) structure. This page explains the general layout of the settings file; the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of all the components of the file. + +A LISFLOOD settings file is made up of 3 elements, each of which has a specific function. + +For a LISFLOOD settings file, the basic structure looks like this: +
+**\**    Start of settings elements
+   **\**    Start of element with options
+                         LISFLOOD options (switches)
+   **\**    End of element with options
+   **\**    Start of element with user-defined variables
+                         User's specific parameters and settings
+   **\**    End of element with user-defined variables
+   **\**    Start of element with 'binding' variables
+                         LISFLOOD model general settings
+   **\**    End of element with 'binding' variables
+**\**    End of settings element
+ + +### Main elements of the settings file +The sections ‘lfuser’, ‘lfoptions’ and ‘lfbinding’' have different purposes, as described below. + ++ **lfoptions** contains **switches to turn on/off specific components of the model**. Within LISFLOOD, there are two categories of options: + - Options that activate OS LISFLOOD optional modules, such as simulate reservoirs, lakes, etc. + - Options to activate the reporting of additional output maps and time series (e.g. soil moisture maps) + + A comprehensive list of available options and default values is contained in the [Annex: settings and options](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/). + + Users are not obliged to include all available options in Settings.xml file: if one option is not specified in Settings.xml, the default option will be automatically used. + If Users leave the ‘lfoptions’ element empty, LISFLOOD will simply run using default options (i.e. run model without optional modules; only report most basic output files). + However, the ‘lfoptions’ element itself (i.e. ) has to be present, even if empty. + + ++ **lfuser** contains user-defined definition of **paths** to all in- and output files, and main model parameters (calibration + time-related). + + The variables in the ‘lfuser’ elements are all text variables, and they are used simply to substitute repeatedly used expressions in the binding element. + + ++ **lfbinding** contains definition of **all parameter values** of LISFLOOD model as well as **all in- and output maps, time series and tables**. + + It is possible to define everything directly in the ‘lfbinding’ element without using any text variables at al. In that case, the ‘lfuser’ element can remain empty, even though it has to be present (i.e. ) [NOT recommended] + + In general, it is a good idea to use user-defined variables for everything that needs to be changed on a regular basis (paths to input maps, tables, meteorological data, and parameter values). This way Users only have to deal with the variables in the ‘lfuser’ element, without having to worry about anything in ‘lfbinding’ at all. “lfuser” allows to have all the important variables defined in the same element. + + + + +## Time convention within OS LISFLOOD model **LISFLOOD model follows an "end of timestep" naming convention** for timestamps of both input (forcings) and output data. @@ -32,15 +102,15 @@ In Settings file, three different keys are used to specify start date, end date > **Both timestamps and time steps ALWAYS refer to the END of the TIME INTERVAL!** -## Using timestamps +### Using timestamps -Timestamps (dates) can be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart. +Timestamps (dates) can be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart ([Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of the Settings.xml file). If hours:minutes are not specified, LISFLOOD will automatically set them to 00:00 When using timestamps, CalendarDayStart key in Settings.xml is only used internally to transform timestamps to model's time steps. -StepStart, StepEnd and timestepInit are used to access NetCDF files containing forcings and state variables, and to create output NetCDF files. +StepStart, StepEnd and timestepInit are used to access NetCDF files containing forcings and state variables, and to create output NetCDF files. ```xml @@ -87,7 +157,7 @@ StepStart, StepEnd and timestepInit are used to access NetCDF files containing f -## Using time steps +### Using time steps Time steps can still be used to set start step and end step of LISFLOOD simulation. ReportSteps can only be provided as time steps numbers. From e7d1921214e0571c81dac18d6db219ebfc683986 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Mon, 11 May 2026 18:57:42 +0200 Subject: [PATCH 48/70] re-nme ESSENTIAL info --- .../index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{2_ESSENTIAL_time-management => 2_ESSENTIAL_concepts_before_getting_started}/index.md (100%) diff --git a/docs/2_ESSENTIAL_time-management/index.md b/docs/2_ESSENTIAL_concepts_before_getting_started/index.md similarity index 100% rename from docs/2_ESSENTIAL_time-management/index.md rename to docs/2_ESSENTIAL_concepts_before_getting_started/index.md From d3e6e459be65d3e431684892a20148531ad56232 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Mon, 11 May 2026 19:02:15 +0200 Subject: [PATCH 49/70] udpate config.yml --- docs/_config.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 4250689a..21cd6629 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -202,10 +202,8 @@ defaults: - section_title: "Step-by-step user guide" items: - - title: "Step 0: Essential before getting started" - url: 2_ESSENTIAL_setting-file - - title: "Step 1: Time convention within LISFLOOD model" - url: 2_ESSENTIAL_time-management + - title: "Step 1: Essential concepts to get started" + url: 2_ESSENTIAL_concepts_before_getting_started - title: "Step 2: Preparing the settings file" url: 3_step3_preparing-setting-file - title: "Step 3: Preparing input files" From b19ea06ea13665d0b98c726ad5fa548406d58981 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Mon, 11 May 2026 19:14:43 +0200 Subject: [PATCH 50/70] re-organize steps --- docs/2_ESSENTIAL_setting-file/index.md | 53 ------ .../index.md | 0 .../index.md | 166 ++++++++++++++++++ .../index.md | 2 +- .../index.md | 0 .../index.md | 0 .../index.md | 0 .../index.md | 0 docs/_config.yml | 12 +- 9 files changed, 173 insertions(+), 60 deletions(-) delete mode 100644 docs/2_ESSENTIAL_setting-file/index.md rename docs/{3_step2_installation => 2_installation}/index.md (100%) create mode 100644 docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md rename docs/{3_step3_preparing-setting-file => 3_step2_preparing-setting-file}/index.md (99%) rename docs/{3_step4_preparing-input-files => 3_step3_preparing-input-files}/index.md (100%) rename docs/{3_step5_model-initialisation => 3_step4_model-initialisation}/index.md (100%) rename docs/{3_step6_running-LISFLOOD => 3_step5_model-cold-warm-start-runs}/index.md (100%) rename docs/{3_step7_commmand-line-flags => 3_step7_command-line-flags}/index.md (100%) diff --git a/docs/2_ESSENTIAL_setting-file/index.md b/docs/2_ESSENTIAL_setting-file/index.md deleted file mode 100644 index e4e4b861..00000000 --- a/docs/2_ESSENTIAL_setting-file/index.md +++ /dev/null @@ -1,53 +0,0 @@ -# LISFLOOD settings file (Settings.xml) - -## Purpose - -In LISFLOOD, all file and parameter specifications are defined in a settings file. The purpose of the settings file is to link variables and parameters in the model to in- and output files (maps, time series, tables) and numerical values. In addition, the settings file can be used to specify several *options*. The settings file has a special (XML) structure. In the next sections the general layout of the settings file is explained. Although the file layout is not particularly complex, a basic understanding of the general principles explained here is essential for doing any successful model runs. - - -## Layout of the settings file - -A LISFLOOD settings file is made up of 4 elements, each of which has a specific function. The general structure of the file is described using XML. - -For a LISFLOOD settings file, the basic structure looks like this: -
-**\**    Start of settings elements
-   **\**    Start of element with options
-                         LISFLOOD options (switches)
-   **\**    End of element with options
-   **\**    Start of element with user-defined variables
-                         User's specific parameters and settings
-   **\**    End of element with user-defined variables
-   **\**    Start of element with 'binding' variables
-                         LISFLOOD model general settings
-   **\**    End of element with 'binding' variables
-**\**    End of settings element
- - -## Main elements of the settings file -This file contains settings for LISFLOOD model. It is made up of 3 elements ‘lfuser’, ‘lfoptions’ and ‘lfbinding’ whose function can be briefly described as follows: - -+ **lfoptions:** it contains **switches to turn on/off specific components of the model**. Within LISFLOOD, there are two categories of options: - - Options that activate special LISFLOOD features, such as simulate reservoirs, perform split routing, etc. - - Options to activate the reporting of additional output maps and time series (e.g. soil moisture maps) - - The complete list of available options and default values is contained in the [Annex: settings and options](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/). - - Users are not obliged to include all available options in Settings.xml file: if one option is not specified in Settings.xml, the default option will be automatically used. - If Users leave the ‘lfoptions’ element empty, LISFLOOD will simply run using default options (i.e. run model without optional modules; only report most basic output files). - However, the ‘lfoptions’ element itself (i.e. ) has to be present, even if empty. - - -+ **lfuser:** it contains user-defined definition of **paths** to all in- and output files, and main model parameters (calibration + time-related). - - The ‘lfuser’ element is used to define (user-defined) text variables. These text variables are used to substitute repeatedly used expressions in the binding element. The only function of the ‘lfuser’ element is to define text variables. Users cannot use any of these text variables within the ‘lfuser’ element. - - The variables in the ‘lfuser’ elements are all text variables, and they are used simply to substitute text in the ‘lfbinding’ element. In practice, it is sometimes convenient to use the same name for a text variable that is defined in the ‘lfuser’ element and a ‘lfbinding’ variable. - - -+ **lfbinding:** it contains definition of **all parameter values** of LISFLOOD model as well as **all in- and output maps, time series and tables**. - - It is possible to define everything directly in the ‘lfbinding’ element without using any text variables at al. In that case, the ‘lfuser’ element can remain empty, even though it has to be present (i.e. ) [NOT recommended] - - In general, it is a good idea to use user-defined variables for everything that needs to be changed on a regular basis (paths to input maps, tables, meteorological data, and parameter values). This way Users only have to deal with the variables in the ‘lfuser’ element, without having to worry about anything in ‘lfbinding’ at all. “lfuser” allows to have all the important variables defined in the same element. - diff --git a/docs/3_step2_installation/index.md b/docs/2_installation/index.md similarity index 100% rename from docs/3_step2_installation/index.md rename to docs/2_installation/index.md diff --git a/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md new file mode 100644 index 00000000..c6d84961 --- /dev/null +++ b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md @@ -0,0 +1,166 @@ +# Essential concepts + +This page presents: +- an overview of the required files and folders +- an overview of the OS LISFLOOD Settings.xml file (the main and essential argument of OS LISFLOOD command line) +- the time convention within lisflood, understanding of the latter is **essential for a correct model set-up**. + +## What is needed to run a OS LISFLOOD model? + +In order the run a simulation you will need: + + - Meteo input maps + - Static input maps + - Tables, only in case specific features such as reservoirs and lakes are included in the modeling excercis + - An empty output directory where all model data can be written + - OS LISFLOOD settings file in .xml format + +The section [Input files](../3_step4_preparing-input-files) provides a detailed description of input maps and tables. + +The settings file (settings.xml) allows the selection of input maps, modelling options, and output variables and storage folder. The settings .xml is the essential argument of OS LISFLOOD command line. The section below presents its main components, an in depth descrition is provided in the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/). + + +## OS LISFLOOD settings file (settings.xml) + + +All input files, output files, and parameter specifications are defined in a settings file. This file links variables and parameters in the model to in- and output files (maps, time series, tables) and numerical values. Moreover, the settings file can be used to specify the various model *options*. The settings file has a special (XML) structure. This page explains the general layout of the settings file; the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of all the components of the file. + +A LISFLOOD settings file is made up of 3 elements, each of which has a specific function. + +For a LISFLOOD settings file, the basic structure looks like this: +
+**\**    Start of settings elements
+   **\**    Start of element with options
+                         LISFLOOD options (switches)
+   **\**    End of element with options
+   **\**    Start of element with user-defined variables
+                         User's specific parameters and settings
+   **\**    End of element with user-defined variables
+   **\**    Start of element with 'binding' variables
+                         LISFLOOD model general settings
+   **\**    End of element with 'binding' variables
+**\**    End of settings element
+ + +### Main elements of the settings file +The sections ‘lfuser’, ‘lfoptions’ and ‘lfbinding’' have different purposes, as described below. + ++ **lfoptions** contains **switches to turn on/off specific components of the model**. Within LISFLOOD, there are two categories of options: + - Options that activate OS LISFLOOD optional modules, such as simulate reservoirs, lakes, etc. + - Options to activate the reporting of additional output maps and time series (e.g. soil moisture maps) + + A comprehensive list of available options and default values is contained in the [Annex: settings and options](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/). + + Users are not obliged to include all available options in Settings.xml file: if one option is not specified in Settings.xml, the default option will be automatically used. + If Users leave the ‘lfoptions’ element empty, LISFLOOD will simply run using default options (i.e. run model without optional modules; only report most basic output files). + However, the ‘lfoptions’ element itself (i.e. ) has to be present, even if empty. + + ++ **lfuser** contains user-defined definition of **paths** to all in- and output files, and main model parameters (calibration + time-related). + + The variables in the ‘lfuser’ elements are all text variables, and they are used simply to substitute repeatedly used expressions in the binding element. + + ++ **lfbinding** contains definition of **all parameter values** of LISFLOOD model as well as **all in- and output maps, time series and tables**. + + It is possible to define everything directly in the ‘lfbinding’ element without using any text variables at al. In that case, the ‘lfuser’ element can remain empty, even though it has to be present (i.e. ) [NOT recommended] + + In general, it is a good idea to use user-defined variables for everything that needs to be changed on a regular basis (paths to input maps, tables, meteorological data, and parameter values). This way Users only have to deal with the variables in the ‘lfuser’ element, without having to worry about anything in ‘lfbinding’ at all. “lfuser” allows to have all the important variables defined in the same element. + + + + +## Time convention within OS LISFLOOD model + +**LISFLOOD model follows an "end of timestep" naming convention** for timestamps of both input (forcings) and output data. + +Accordingly, if timestamp "02/01/2017 06:00" is used for naming a time step of daily accumulated rainfall data, that time step will contain rainfall accumulation between "01/01/2017 06:00" and "02/01/2017 06:00" (see following figure) + +![](../media/image62.png) + +Outputs of LISFLOOD model will use the same naming convention. If timestamp "02/01/2017 06:00" is used for naming a time step of daily discharge (output), that time step will contain average discharge over the period between "01/01/2017 06:00" and "02/01/2017 06:00" (see following figure) + +![](../media/image63.png) + +In Settings file, three different keys are used to specify start date, end date and state file date for LISFLOOD simulation: + +- **StepStart:** this key specifies the starting date of the simulation. The starting date is also the date of the first LISFLOOD output. + >In Settings.xml: textvar name="StepStart" value="02/01/2017 06:00" + + >For example, if we set StepStart to "02/01/2017 06:00", this means that LISFLOOD will automatically use forcing data with timestamp "02/01/2017 06:00" (i.e. accumulated rainfall over the period between "01/01/2017 06:00" and "02/01/2017 06:00") and it will also store outputs with the same timestamp (i.e. average discharge over the period between "01/01/2017 06:00" and "02/01/2017 06:00"). + +- **StepEnd:** this key specifies the end date of the simulation. The end date is also the date of the last LISFLOOD output. + >In Settings.xml: textvar name="StepEnd value="05/01/2017 06:00" + + > For example, if we set StepEnd to "05/01/2017 06:00", this means that last output from LISFLOOD run will have timestamp "05/01/2017 06:00" + +- **timestepInit:** this key is used to specify which timestamp must be used to retrieve information from existing state files (i.e. from a previous simulation) + >For example, if we want to start a new simulation at "03/01/2017 06:00" and we want to use hydrological state information from the last time step, we will set timestepInit to "02/01/2017 06:00". Outputs with timestamp "02/01/2017 06:00" will be used to initialize the model, while the first output of the simulation will be be store with timestamp "03/01/2017 06:00" + +![](../media/image64.png) + +> **Both timestamps and time steps ALWAYS refer to the END of the TIME INTERVAL!** + + +### Using timestamps + +Timestamps (dates) can be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart ([Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of the Settings.xml file). + +If hours:minutes are not specified, LISFLOOD will automatically set them to 00:00 + +When using timestamps, CalendarDayStart key in Settings.xml is only used internally to transform timestamps to model's time steps. + +StepStart, StepEnd and timestepInit are used to access NetCDF files containing forcings and state variables, and to create output NetCDF files. + + +```xml + + ************************************************************** + TIME-RELATED CONSTANTS + ************************************************************** + + + + Calendar day of 1st day in model run + Day of the year of first map (e.g. xx0.001) even if the model start + from map e.g. 500 + e.g. 1st of January: 1; 1st of June 151 (or 152 in leap year) + Needed to read out LAI tables correctly + + + + + timestep [seconds] + + + + + Sub time step used for kinematic wave channel routing [seconds] + + + + + Number of first time step in simulation + + + + + Number of last time step in simulation + + + + + Time steps at which to write model state maps + + +``` + + + +### Using time steps + +Time steps can still be used to set start step and end step of LISFLOOD simulation. ReportSteps can only be provided as time steps numbers. + +All steps numbers are referred to CalendarDayStart + +When using time steps, dates (including hours and minutes) to retrieve data for forcings and state variables are automatically determined by LISFLOOD. diff --git a/docs/3_step3_preparing-setting-file/index.md b/docs/3_step2_preparing-setting-file/index.md similarity index 99% rename from docs/3_step3_preparing-setting-file/index.md rename to docs/3_step2_preparing-setting-file/index.md index 5d351349..9ba96bf1 100644 --- a/docs/3_step3_preparing-setting-file/index.md +++ b/docs/3_step2_preparing-setting-file/index.md @@ -2,7 +2,7 @@ This page describes how to prepare your own settings file. Instead of writing the settings file completely from scratch, we suggest usinng the [reference settings file](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml) as a starting point. -In oder the run a simulation you will need: +In order the run a simulation you will need: - Meteo input maps - Static input maps diff --git a/docs/3_step4_preparing-input-files/index.md b/docs/3_step3_preparing-input-files/index.md similarity index 100% rename from docs/3_step4_preparing-input-files/index.md rename to docs/3_step3_preparing-input-files/index.md diff --git a/docs/3_step5_model-initialisation/index.md b/docs/3_step4_model-initialisation/index.md similarity index 100% rename from docs/3_step5_model-initialisation/index.md rename to docs/3_step4_model-initialisation/index.md diff --git a/docs/3_step6_running-LISFLOOD/index.md b/docs/3_step5_model-cold-warm-start-runs/index.md similarity index 100% rename from docs/3_step6_running-LISFLOOD/index.md rename to docs/3_step5_model-cold-warm-start-runs/index.md diff --git a/docs/3_step7_commmand-line-flags/index.md b/docs/3_step7_command-line-flags/index.md similarity index 100% rename from docs/3_step7_commmand-line-flags/index.md rename to docs/3_step7_command-line-flags/index.md diff --git a/docs/_config.yml b/docs/_config.yml index 21cd6629..0fae6efb 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -198,20 +198,20 @@ defaults: - section_title: "Installation" items: - title: "Installation and testing" - url: 3_step2_installation + url: 2_installation - section_title: "Step-by-step user guide" items: - title: "Step 1: Essential concepts to get started" - url: 2_ESSENTIAL_concepts_before_getting_started + url: 2_step1_ESSENTIAL_concepts_to_get_started - title: "Step 2: Preparing the settings file" - url: 3_step3_preparing-setting-file + url: 3_step2_preparing-setting-file - title: "Step 3: Preparing input files" - url: 3_step4_preparing-input-files + url: 3_step3_preparing-input-files - title: "Step 4: Initialisation of LISFLOOD" - url: 3_step5_model-initialisation + url: 3_step4_model-initialisation - title: "Step 5: Running LISFLOOD" - url: 3_step6_running-LISFLOOD + url: 3_step5_model-cold-warm-start-runs - title: "Step 6: model output" url: 3_step6_model-output - title: "Step 7: commmand line flags" From 7b6786de98fbec7a5766ecd24ec995866f62df99 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 13 May 2026 18:59:32 +0200 Subject: [PATCH 51/70] review Annex Settings and Options --- docs/4_annex_settings_and_options/index.md | 1467 ++++++++------------ 1 file changed, 569 insertions(+), 898 deletions(-) diff --git a/docs/4_annex_settings_and_options/index.md b/docs/4_annex_settings_and_options/index.md index b78a62fc..78e1d788 100644 --- a/docs/4_annex_settings_and_options/index.md +++ b/docs/4_annex_settings_and_options/index.md @@ -1,915 +1,586 @@ -The Tables below presents a comprehensive list of setting options, inputs, and outputs. +This annex presents a nearly comprehensive list of setting options, inputs, and outputs. +The content is organized in the following tables: +- **lfoptions**: list of available switches to activate optional modules and optional outputs (time series and map formats) +- **luser*: list of variables which are generally defined by the users. +- **lfbinding**: list of model variables. +- **initial variables*: list of variables required for model initialization (cold and warm start of both prerun and run) +- ** -**Table:** *LISFLOOD Settings.* -| section (XML) | group (XML) | module | eqz | KEY | cold | warm | Type | I/O | Description | -| --------------- |---------------------------------------------------------------|------------------------------------| ------ |---------------------------------|---------------------------------------------------|---------------------------------------------------| --------------- |------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfoptions | | SETTINGS | | TemperatureInKelvin | | | switch | input | Use temperature data in C (=0) or in K (=1) | -| lfoptions | | SETTINGS | | gridSizeUserDefined | | | switch | input | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | -| lfoptions | | DYNAMIC WAVE | | dynamicWave | | | switch | input | Activate dynamic wave routing | -| lfoptions | | INFLOW | | inflow | | | switch | input | Use inflow hydrographs | -| lfoptions | | SOIL | | simulatePF | | | switch | input | Calculate pF values from soil moisture | -| lfoptions | | LAKES | | simulateLakes | | | switch | input | Simulate unregulated lakes (kin. wave only) | -| lfoptions | | POLDERS | | simulatePolders | | | switch | input | Simulate polders (dyn. wave only) | -| lfoptions | | RESERVOIRS | | simulateReservoirs | | | switch | input | Simulate retention and hydropower reservoirs (kin. wave only) | -| lfoptions | | WATER LEVELS | | simulateWaterLevels | | | switch | input | Activate computation of water level maps / time series (does not affect routing) | -| lfoptions | | LANDUSE CHANGE | | TransientLandUseChange | | | switch | input | Activate reading of time changing land use description | -| lfoptions | | WATER ABSTRACTION | | TransientWaterDemandChange | | | switch | input | Activate reading of time changing water demand | -| lfoptions | | WATER ABSTRACTION | | useWaterDemandAveYear | | | switch | input | Use "average" year for water demand and loop it over years | -| lfoptions | | TRANSMISSION LOSS | | TransLoss | | | switch | input | Activate transmission loss | -| lfoptions | | DOUBLE KINEMATIC WAVE | | SplitRouting | | | switch | input | Activate double kinematic wave routing | -| lfoptions | | MCT DIFFUSIVE WAVE | | MCTRouting | | | switch | input | Activate MCT diffusive wave routing | -| lfoptions | | WATER ABSTRACTION | | wateruse | | | switch | input | Activate water use computation | -| lfoptions | | GROUNDWATER | | groundwaterSmooth | | | switch | input | Activate smoothing for groundwater to correct error by using windowtotal, based on groundwater bodies and catchments | -| lfoptions | | WATER ABSTRACTION | | wateruseRegion | | | switch | input | Use water regions in water use module | -| lfoptions | | IRRIGATION | | drainedIrrigation | | | switch | input | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | -| lfoptions | | IRRIGATION | | riceIrrigation | | | switch | input | Activate computation for paddy rice irrigation and abstraction | -| lfoptions | | EVAPO | | openwaterevapo | | | switch | input | Compute evaporation from open water | -| lfoptions | | EVAPO | | varfractionwater | | | switch | input | Compute the fraction of pixel that is open water | -| lfoptions | | INDICATOR | | indicator | | | switch | input | Activate computation of indicators (such as WEI, e-flow, etc) | -| lfoptions | | SETTINGS | | MonteCarlo | | | switch | input | Activate MonteCarlo simulation | -| lfoptions | | SETTINGS | | EnKF | | | switch | input | Activate EnKF simulation | -| lfoptions | | SETTINGS | | InitLisflood | | | switch | input | Run LISFLOOD initialization run | -| lfoptions | | SETTINGS | | InitLisfloodwithoutSplit | | | switch | input | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | -| lfoptions | | IO | | readNetcdfStack | | | switch | input | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | -| lfoptions | | IO | | writeNetcdfStack | | | switch | input | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | -| lfoptions | | IO | | writeNetcdf | | | switch | input | Write NetCDF files for END files (single netcdf) | -| lfoptions | | DISCHARGE | | repDischargeTs | | | switch rep tss | input | Report discharge time series at gauges | -| lfoptions | | LOG | | repInternalCom | | | switch rep tss | input | Report internal number of sub step for soil, channel routing, water use | -| lfoptions | | LOG | | repMBTs | | | switch rep tss | input | Report timeseries of absolute cumulative mass balance error | -| lfoptions | | STATE | | repStateSites | | | switch rep tss | input | Report state variables at sites | -| lfoptions | | STATE | | repRateSites | | | switch rep tss | input | Report state variables rates at sites | -| lfoptions | | STATE | | repStateUpsGauges | | | switch rep tss | input | Report timeseries of model variables, averaged over contributing area of each gauging station | -| lfoptions | | STATE | | repRateUpsGauges | | | switch rep tss | input | Report timeseries of model rate variables, averaged over contributing area of each gauging station | -| lfoptions | | METEO | | repMeteoUpsGauges | | | switch rep tss | input | Report timeseries of meteo input data | -| lfoptions | | INFLOW | | repLZAvInflowSites | | | switch rep tss | input | Report time serie of average percolation rate from upper to lower groundwater zone at sites | -| lfoptions | | INFLOW | | repLZAvInflowUpsGauges | | | switch rep tss | input | Report time serie of average percolation rate from upper to lower groundwater zone at gauges | -| lfoptions | | WATER ABSTRACTION | | repwateruseGauges | | | switch rep tss | input | Report water use ts at gauges | -| lfoptions | | WATER ABSTRACTION | | repwateruseSites | | | switch rep tss | input | Report water use ts at sistes | -| lfoptions | | WATER LEVELS | | repWaterLevelTs | | | switch rep tss | input | Report water level ts | -| lfoptions | | SOIL | | repPFUpsGauges | | | switch rep tss | input | Report PF ts at gauges | -| lfoptions | | SOIL | | repPFSites | | | switch rep tss | input | Report PF ts at sistes | -| lfoptions | | LAKES | | repsimulateLakes | | | switch rep tss | input | Report time series of lakes | -| lfoptions | | RESERVOIRS | | repsimulateReservoirs | | | switch rep tss | input | Report time series of reservoirs | -| lfoptions | | POLDERS | | repsimulatePolders | | | switch rep tss | input | Report time series of polders | -| lfoptions | | LOG | | repBal1 | | | switch rep tss | input | Report water balance TS | -| lfoptions | | STATE | | repStateMaps | | | switch rep maps | input | Report maps of model state variables (as defined by "ReportSteps" variable) | -| lfoptions | | STATE | | repEndMaps | | | switch rep maps | input | Report maps of model state variables (at last time step) | -| lfoptions | | METEO | | repPrecipitationMaps | | | switch rep maps | input | Report precipitation | -| lfoptions | | METEO | | repTavgMaps | | | switch rep maps | input | Report average temperature maps | -| lfoptions | | EVAPO | | repETRefMaps | | | switch rep maps | input | Report reference evapo-transpiration | -| lfoptions | | EVAPO | | repESRefMaps | | | switch rep maps | input | Report reference soil evaporation | -| lfoptions | | EVAPO | | repEWRefMaps | | | switch rep maps | input | Report reference evaporation of intercepted water | -| lfoptions | | DISCHARGE | | repAverageDis | | | switch rep maps | input | Report average discharge | -| lfoptions | | ROUTING | | repChanCrossSectionMaps | | | switch rep maps | input | Report total cross-section area for channels | -| lfoptions | | INTERCEPTION | | repCumInterCeptionMaps | | | switch rep maps | input | Report cumulative interception | -| lfoptions | | DISCHARGE | | repDischargeMaps | | | switch rep maps | input | Report maps of discharge (for each time step) | -| lfoptions | | METEO | | repDSLRMaps | | | switch rep maps | input | Report maps with number of days since the last rainfall event | -| lfoptions | | EVAPO | | repESActMaps | | | switch rep maps | input | Report actual soil evaporation | -| lfoptions | | EVAPO | | repEWIntMaps | | | switch rep maps | input | Report evaporation of intercepted water | -| lfoptions | | SNOW | | repFrostIndexMaps | | | switch rep maps | input | Report frost index maps | -| lfoptions | | GROUNDWATER | | repGwLossMaps | | | switch rep maps | input | Report groundwater loss maps | -| lfoptions | | GROUNDWATER | | repGwPercUZLZMaps | | | switch rep maps | input | Report maps of percolation from upper to lower ground water zone (for each time step) | -| lfoptions | | INFILTRATION | | repInfiltrationMaps | | | switch rep maps | input | Report infiltration maps | -| lfoptions | | INTERCEPTION | | repInterceptionMaps | | | switch rep maps | input | Report interception maps | -| lfoptions | | LEAF | | repLeafDrainageMaps | | | switch rep maps | input | Report leaf drainage maps | -| lfoptions | | GROUNDWATER | | repLZAvInflowMap | | | switch rep maps | input | Report lower groundwater zone inflow maps | -| lfoptions | | GROUNDWATER | | repLZMaps | | | switch rep maps | input | Report maps of lower groundwater zone storage (for each time step) | -| lfoptions | | GROUNDWATER | | repLZOutflowMaps | | | switch rep maps | input | Report lower groundwater zone outflow maps | -| lfoptions | | PERCOLATION | | repPercolationMaps | | | switch rep maps | input | Report percolation maps | -| lfoptions | | SOIL | | repPFMaps | | | switch rep maps | input | Report pF and vegetation stress due to low soil moisture | -| lfoptions | | SOIL | | repPFForestMaps | | | switch rep maps | input | Report pF and vegetation stress due to low soil moisture for forest fraction | -| lfoptions | | SOIL | | repPrefFlowMaps | | | switch rep maps | input | Report preferential flow (rapid bypass soil matrix) | -| lfoptions | | METEO | | repRainMaps | | | switch rep maps | input | Report rain excluding snow | -| lfoptions | | GROUNDWATER | | repSeepSubToGWMaps | | | switch rep maps | input | Report flux between sub soil and GW | -| lfoptions | | SNOW | | repSnowCoverMaps | | | switch rep maps | input | Report maps of snow cover (for each time step) | -| lfoptions | | SNOW | | repSnowMaps | | | switch rep maps | input | Report maps of snow (for each time step) | -| lfoptions | | SNOW | | repSnowMeltMaps | | | switch rep maps | input | Report maps of snowmelt (for each time step) | -| lfoptions | | SURFACE | | repSurfaceRunoffMaps | | | switch rep maps | input | Report maps of surface runoff (for each time step) | -| lfoptions | | TRANSPIRATION | | repTaMaps | | | switch rep maps | input | Report transpiration maps | -| lfoptions | | SOIL | | repThetaMaps | | | switch rep maps | input | Reporting of *individual* model state variables as maps THETA | -| lfoptions | | SOIL | | repThetaForestMaps | | | switch rep maps | input | Reporting of *individual* model state variables as maps THETA FOREST | -| lfoptions | | SOIL | | repThetaIrrigationMaps | | | switch rep maps | input | Report irrigation mapsrE | -| lfoptions | | SOIL | | repTotalRunoffMaps | | | switch rep maps | input | Report total runoff | -| lfoptions | | GROUNDWATER | | repUZMaps | | | switch rep maps | input | Report maps of upper groundwater zone storage (for each time step) | -| lfoptions | | GROUNDWATER | | repUZOutflowMaps | | | switch rep maps | input | Report maps for upper groundwater zone outflow | -| lfoptions | | ROUTING | | repWaterDepthMaps | | | switch rep maps | input | Report water depth on soil surface | -| lfoptions | | ROUTING | | repWaterLevelMaps | | | switch rep maps | input | Report water level in channels | -| lfoptions | | EVAPO | | ETActMaps | | | switch rep maps | input | Report actual evapo-transpiration | -| lfoptions | | ROUTING | | repFastRunoffMaps | | | switch rep maps | input | Report fast runoff = surface + UZ | -| lfoptions | | WATER STRESS | | repRWS | | | switch rep maps | input | Report soil transpiration reduction factor RWP | -| lfoptions | | WATER STRESS | | repStressDays | | | switch rep maps | input | Report soil transpiration reduction factor RWP for forest | -| lfoptions | | SOIL | | repPF1Maps | | | switch rep maps | input | Report PF1 maps | -| lfoptions | | SOIL | | repPF2Maps | | | switch rep maps | input | Report PF2 maps | -| lfoptions | | WATER ABSTRACTION | | repTotalAbs | | | switch rep maps | input | Report total water abstraction | -| lfoptions | | WATER ABSTRACTION | | repTotalWUse | | | switch rep maps | input | Report total water use | -| lfoptions | | INDICATOR | | repWIndex | | | switch rep maps | input | Report indexes and indicators | -| lfuser | AREA AND OUTLETS | SETTINGS | | PathRoot | /perm/ma/ma9/xdom/data/staticData/lisflood | /perm/ma/ma9/xdom/data/staticData/lisflood | path | input | Root directory | -| lfuser | AREA AND OUTLETS | SETTINGS | | MaskMap | /perm/ma/ma9/xdom/data/staticData/lisflood/area | /perm/ma/ma9/xdom/data/staticData/lisflood/area | map | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | -| lfuser | AREA AND OUTLETS | SETTINGS | | Gauges | $(PathMaps)/outlets.map | $(PathMaps)/outlets.map | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) lat lon (lat2 lon2 ...) or pcraster maps or netcdf maps | -| lfuser | AREA AND OUTLETS | SETTINGS | | netCDFtemplate | $(PathMaps)/elvstd.nc | $(PathMaps)/elvstd.nc | map | input | netcdf template used to copy metadata information for writing netcdf $(PathEvapo)/$(PrefixE0) | -| lfuser | TIMESTEP RELATED PARAMETERS | SETTINGS | | CalendarDayStart | 1/2/1990 6:00 | 1/2/2015 6:00 | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. It MUST be a date as string, see code for list of available date formats. It can now include also HH:MM, if not specified they are set as 00:00 PCRaster: Day of the year of first map (e.g. xx000.001) even if the model start from map e.g. 500 e.g. 1st of January: 1; 1st of June 151 (or 152 in leap year) Needed to read out LAI tables correctly | -| lfuser | TIMESTEP RELATED PARAMETERS | SETTINGS | | DtSec | 86400 | 86400 | value | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | -| lfuser | TIMESTEP RELATED PARAMETERS | KINEMATIC WAVE | | DtSecChannel | 3600 | 3600 | value | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | -| lfuser | TIMESTEP RELATED PARAMETERS | SETTINGS | | StepStart | 1/2/1990 6:00 | 1/2/2015 6:00 | value/date | input | Step id number or date of the simulation start step. See code for a list of available date formats. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | -| lfuser | TIMESTEP RELATED PARAMETERS | SETTINGS | | StepEnd | 1/1/2015 6:00 | 1/1/2017 6:00 | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | -| lfuser | TIMESTEP RELATED PARAMETERS | SETTINGS | | ReportSteps | 1..9999 | 1..9999 | value | input | Time steps at which to write model state maps (i.e. only those maps that would be needed to define initial conditions for succeeding model run). Use: #,#,# to specify single step numbers #..# to print all state files between one step and another one "endtime" to print state files for final step (to state file in NetCDF file format stack) | -| lfuser | MONTE CARLO | SETTINGS | | EnsMembers | 2 | 2 | value | input | Number of sample to use in MonteCarlo simulations | -| lfuser | MONTE CARLO | SETTINGS | | nrCores | 2 | 2 | value | input | Number of cores of the computer to use in MonteCarlo simulations This only works with Linux, if set to 1 no forking will be used | -| lfuser | FILTER KALMAN | SETTINGS | | FilterSteps | 10 | 10 | value | input | Time steps at which to write model state maps (i.e. only those maps that would be needed to define initial conditions for succeeding model run) | -| lfuser | GROUNDWATER RELATED PAR | GROUNDWATER | Tuz | UpperZoneTimeConstant | $(PathParams)/params_UpperZoneTimeConstant | $(PathParams)/params_UpperZoneTimeConstant | value/map | input calib par | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | -| lfuser | GROUNDWATER RELATED PAR | GROUNDWATER | Tlz | LowerZoneTimeConstant | $(PathParams)/params_LowerZoneTimeConstant | $(PathParams)/params_LowerZoneTimeConstant | value/map | input calib par | Time constant for the lower groundwater zone [days] This is the average time a water 'particle' remains in the reservoir if we had a stationary system (average inflow=average outflow) default: 100 | -| lfuser | GROUNDWATER RELATED PAR | GROUNDWATER | GWperc | GwPercValue | $(PathParams)/params_GwPercValue | $(PathParams)/params_GwPercValue | value/map | input calib par | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | -| lfuser | GROUNDWATER RELATED PAR | GROUNDWATER | floss | GwLoss | $(PathParams)/params_GwLoss | $(PathParams)/params_GwLoss | value/map | input calib par | Rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. A value of 0 (closed lower boundary) is recommended as a starting value; default: 0.0 | -| lfuser | INFILTRATION | INFILTRATION | b | b_Xinanjiang | $(PathParams)/params_b_Xinanjiang | $(PathParams)/params_b_Xinanjiang | value/map | input calib par | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | -| lfuser | INFILTRATION | INFILTRATION | cpref | PowerPrefFlow | $(PathParams)/params_PowerPrefFlow | $(PathParams)/params_PowerPrefFlow | value/map | input calib par | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | -| lfuser | ROUTING | KINEMATIC WAVE | n | CalChanMan | $(PathParams)/params_CalChanMan1 | $(PathParams)/params_CalChanMan1 | value/map | input calib par | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | -| lfuser | SNOW AND FROST | SNOW | Cm | SnowMeltCoef | $(PathParams)/params_SnowMeltCoef | $(PathParams)/params_SnowMeltCoef | value/map | input calib par | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | -| lfuser | ROUTING | DOUBLE KINEMATIC WAVE | n? | CalChanMan2 | $(PathParams)/params_CalChanMan2 | $(PathParams)/params_CalChanMan2 | value/map | input calib par | PBchange Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | -| lfuser | ROUTING | MCT DIFFUSIVE WAVE | n? | CalChanMan3 | $(PathParams)/params_CalChanMan3 | $(PathParams)/params_CalChanMan3 | value/map | input calib par | Multiplier [-] applied to Channel Manning's n for MCT diffusive wave routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | -| lfuser | CALIBRATION | LAKES | | LakeMultiplier | $(PathParams)/params_LakeMultiplier | $(PathParams)/params_LakeMultiplier | value/map | input calib par | default: 1.0 $(PathParams)/params_LakeMultiplier.nc Multiplier applied to the lake parameter A | -| lfuser | CALIBRATION | RESERVOIRS | | adjust_Normal_Flood | $(PathParams)/params_adjust_Normal_Flood | $(PathParams)/params_adjust_Normal_Flood | value/map | input calib par | default: 0.8 $(PathParams)/params_adjust_Normal_Flood.nc adjusting the balance between normal and flood storage big values (= closer to 1.0 = close to flood) results in keeping the outflow longer at rnormq Range 0.01 - 0.99 | -| lfuser | CALIBRATION | RESERVOIRS | | ReservoirRnormqMult | $(PathParams)/params_ReservoirRnormqMult | $(PathParams)/params_ReservoirRnormqMult | value/map | input calib par | default: 1.0 $(PathParams)/params_ReservoirRnormqMult.nc Reservoir rnormq (normal outflow) fraction of the value in table rnormq.txt range: 0.5 - 2 | -| lfuser | EVAPO(TRANSPI)RATION AND INTERCEPTION | SETTINGS | | AvWaterRateThreshold | 5 | 5 | value | input par | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | -| lfuser | FILE PATHS | SETTINGS | | PathOut | outputs/ecWB/ecWB_1990-2014/ | outputs/ecWB/ecWB_2015-2016/ | path | input | Output path (org=$(PathRoot)/out) It is the directory where all output files are written. It must be an existing directory (if not you will get an error message – not immediately but after 256 timesteps, when the time series are written for the first time). | -| lfuser | FILE PATHS | SETTINGS | | PathInit | initcond/ecWB/ | outputs/ecWB/ecWB_1990-2014/ | path | input | Path of the initial value maps e.g. lzavin.map (org=$(PathRoot)/outPo) It is the directory where the initial files are located, to initialize a “warm” start. It can be also the PathOut directory. | -| lfuser | FILE PATHS | SETTINGS | | PathMaps | /perm/ma/ma9/xdom/data/staticData/lisflood | /perm/ma/ma9/xdom/data/staticData/lisflood | path | input | Maps path it is the directory where all input base maps are located | -| lfuser | FILE PATHS | INFLOW | | PathInflow | $(PathRoot)/inflow | $(PathRoot)/inflow | path | input | Inflow path | -| lfuser | FILE PATHS | SETTINGS | | PathParams | $(PathMaps)/parameters | $(PathMaps)/parameters | path | input | Calibration parameter path | -| lfuser | FILE PATHS | TABLE | | PathTables | $(PathRoot)/tables | $(PathRoot)/tables | path | input | Tables path | -| lfuser | FILE PATHS | TABLES | | PathMapsTables | $(PathMaps)/table2map | $(PathMaps)/table2map | path | input | Maps instead tables path | -| lfuser | FILE PATHS | SOIL | | PathSoilHyd | $(PathMaps)/soilhyd | $(PathMaps)/soilhyd | path | input | Maps instead tables for soil hydraulics path Directory where the soil hydraulic property maps are located | -| lfuser | FILE PATHS | LANDUSE | | PathMapsLandUseChange | $(PathMaps)/landuse_rcp85_20062125 | $(PathMaps)/landuse_rcp85_20062125 | path | input | Maps for transient land use changes every 5 years | -| lfuser | FILE PATHS | LANDUSE | | PathMapsLanduse | $(PathMaps)/landuse2006 | $(PathMaps)/landuse2006 | path | input | Maps for land use fractions and related land use maps | -| lfuser | FILE PATHS | WATER USE | | PathWaterUse | forcings/ecWaterDemand19902014/ | $(PathMaps)/waterdemand | path | input | Water use maps path | -| lfuser | FILE PATHS | METEO | | PathMeteo | forcings/ecWB_grids_1990_2016/ | forcings/ecWB_grids_1990_2016/ | path | input | Meteo path Directory where all maps with meteorological input are located (rain, evapo(transpi)ration, temperature) | -| lfuser | FILE PATHS | LAI | | PathLAI | $(PathMaps)/lai | $(PathMaps)/lai | path | input | Leaf Area Index maps path Directory where you Leaf Area Index maps are located | -| lfuser | FILE PATHS | WATER FRACTION | | PathVarWaterfraction | $(PathMaps)/variablewater | $(PathMaps)/variablewater | path | input | variable water fraction maps path | -| lfuser | INITIAL CONDITIONS | SETTINGS | | timestepInit | 1/2/1990 6:00 | 1/1/2015 6:00 | value/date | input initial | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfuser | INITIAL CONDITIONS | SURFACE | | OFDirectInitValue | 0 | $(PathInit)/ofdir | value/map | input initial/internal | Initial water volume for direct fraction on catchment surface [m3] | -| lfuser | INITIAL CONDITIONS | SURFACE | | OFOtherInitValue | 0 | $(PathInit)/ofoth | value/map | input initial/internal | Initial water volume for other fraction on catchment surface [m3] | -| lfuser | INITIAL CONDITIONS | SURFACE | | OFForestInitValue | 0 | $(PathInit)/offor | value/map | input initial/internal | Initial water volume for forest fraction on catchment surface [m3] | -| lfuser | INITIAL CONDITIONS | OVERLAND FLOW | | WaterDepthInitValue | 0 | $(PathInit)/wdept | value/map | | initial overland flow water depth [mm] Initial amount of water on the soil surface | -| lfuser | INITIAL CONDITIONS | SNOW | | SnowCoverAInitValue | 0 | $(PathInit)/scova | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone A [mm] | -| lfuser | INITIAL CONDITIONS | SNOW | | SnowCoverBInitValue | 0 | $(PathInit)/scovb | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone B [mm] | -| lfuser | INITIAL CONDITIONS | SNOW | | SnowCoverCInitValue | 0 | $(PathInit)/scovc | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone C [mm] | -| lfuser | INITIAL CONDITIONS | SNOW | F | FrostIndexInitValue | 0 | $(PathInit)/frost | value/map | input initial/internal | initial Frost Index value [C day-1] | -| lfuser | INITIAL CONDITIONS | INTERCEPTION | | CumIntInitValue | 0 | $(PathInit)/cum | value/map | input initial/internal | cumulative interception [mm] Initial interception storage | -| lfuser | INITIAL CONDITIONS | GROUNDWATER | | UZInitValue | 0 | $(PathInit)/uz | value/map | input initial/internal | It is the initial storage in the upper groundwater zone [mm] | -| lfuser | INITIAL CONDITIONS | SOIL | Dslr | DSLRInitValue | 1 | $(PathInit)/dslr | value/map | input initial/internal | initial number of days since the last rainfall event [days] | -| lfuser | INITIAL CONDITIONS | GROUNDWATER | | LZInitValue | -9999 | $(PathInit)/lz | value/map | input initial/internal | It is the initial storage in the lower groundwater zone [mm] -9999: use steady-state storage | -| lfuser | INITIAL CONDITIONS | KINEMATIC WAVE | | TotalCrossSectionAreaInitValue | -9999 | $(PathInit)/chcro | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull It is the initial cross-sectional area [m2] of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). | -| lfuser | INITIAL CONDITIONS | SOIL | | ThetaInit1Value | -9999 | $(PathInit)/tha | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the supercificial soil layer. | -| lfuser | INITIAL CONDITIONS | SOIL | | ThetaInit2Value | -9999 | $(PathInit)/thb | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the upper soil layer. | -| lfuser | INITIAL CONDITIONS | SOIL | | ThetaInit3Value | -9999 | $(PathInit)/thc | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the lower soil layer. | -| lfuser | INITIAL CONDITIONS | DOUBLE KINEMATIC WAVE | | CrossSection2AreaInitValue | -9999 | $(PathInit)/ch2cr | value/map | input initial/internal | initial channel cross-sectional area [m2] of the water in the river channels for 2nd routing channel -9999: use 0 | -| lfuser | INITIAL CONDITIONS | DOUBLE KINEMATIC WAVE | | PrevSideflowInitValue | -9999 | $(PathInit)/chside | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfuser | INITIAL CONDITIONS | MCT DIFFUSIVE WAVE | | PrevCmMCTInitValue | -9999 | $(PathInit)/prevcm | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfuser | INITIAL CONDITIONS | MCT DIFFUSIVE WAVE | | PrevDmMCTInitValue | -9999 | $(PathInit)/prevdm | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfuser | INITIAL CONDITIONS | LAKES | | LakeInitialLevelValue | -9999 | $(PathInit)/lakeh | value/map | input initial/internal | Initial lake level [m] -9999 sets initial value to steady-state level | -| lfuser | INITIAL CONDITIONS | KINEMATIC WAVE | | PrevDischarge | -9999 | $(PathInit)/chanq | value/map | input initial/internal | initial discharge from previous run only needed for MCT diffusive routing -9999: use 0 It is the initial discharge from previous run [m3s-1] used for MCT diffusive routing. Note that PrevDischarge is the instantaneous discharge referred to the end of the time step. | -| lfuser | INITIAL CONDITIONS | KINEMATIC WAVE | | PrevDischargeAvg | -9999 | $(PathInit)/chanqavgdt | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only -9999: use 0 It is the initial discharge from previous run [m3s-1] used for lakes, reservoirs and transmission loss Note that PrevDischargeAvg is the average discharge for the last routing sub-step. | -| lfuser | INITIAL CONDITION FOREST | INTERCEPTION | | CumIntForestInitValue | 0 | $(PathInit)/cumf | value/map | input initial/internal | cumulative interception forest [mm] | -| lfuser | INITIAL CONDITION FOREST | GROUNDWATER | | UZForestInitValue | 0 | $(PathInit)/uzf | value/map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | -| lfuser | INITIAL CONDITION FOREST | SOIL | | DSLRForestInitValue | 1 | $(PathInit)/dslf | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | -| lfuser | INITIAL CONDITION FOREST | SOIL | | ThetaForestInit1Value | -9999 | $(PathInit)/thfa | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | -| lfuser | INITIAL CONDITION FOREST | SOIL | | ThetaForestInit2Value | -9999 | $(PathInit)/thfb | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | -| lfuser | INITIAL CONDITION FOREST | SOIL | | ThetaForestInit3Value | -9999 | $(PathInit)/thfc | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | -| lfuser | INITIAL CONDITION IRRIGATION | INTERCEPTION | | CumIntIrrigationInitValue | 0 | $(PathInit)/cumi | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfuser | INITIAL CONDITION IRRIGATION | GROUNDWATER | | UZIrrigationInitValue | 0 | $(PathInit)/uzi | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfuser | INITIAL CONDITION IRRIGATION | SOIL | | DSLRIrrigationInitValue | 1 | $(PathInit)/dsli | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | -| lfuser | INITIAL CONDITION IRRIGATION | SOIL | | ThetaIrrigationInit1Value | -9999 | $(PathInit)/thia | value/map | input initial/internal | initial soil moisture content layer 1a for irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION IRRIGATION | SOIL | | ThetaIrrigationInit2Value | -9999 | $(PathInit)/thib | value/map | input initial/internal | initial soil moisture content layer 1b for irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION IRRIGATION | SOIL | | ThetaIrrigationInit3Value | -9999 | $(PathInit)/thic | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITIONS IMPERVIOUS AREAS | SOIL | | CumIntSealedInitValue | 0 | $(PathInit)/cseal | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfuser | PREFIXES METEO VEG VARIAB | METEO | | PrefixPrecipitation | pr | pr | prefix | input forcings | prefix precipitation maps | -| lfuser | PREFIXES METEO VEG VARIAB | METEO | | PrefixTavg | ta | ta | prefix | input forcings | prefix average temperature maps | -| lfuser | PREFIXES METEO VEG VARIAB | EVAPO | | PrefixE0 | e0 | e0 | prefix | input forcings | prefix E0 (potential open water evaporation) maps | -| lfuser | PREFIXES METEO VEG VARIAB | EVAPO | | PrefixES0 | es | es | prefix | input forcings | prefix ES0 (potential open bare-soil evaporation)maps | -| lfuser | PREFIXES METEO VEG VARIAB | EVAPO | | PrefixET0 | et | et | prefix | input forcings | prefix ET0 (potential reference evapotranspioration) maps | -| lfuser | PREFIXES METEO VEG VARIAB | LAI | | PrefixLAIOther | laio | laio | prefix | input forcings | prefix LAI (Leaf Area Index) maps | -| lfuser | PREFIXES METEO VEG VARIAB | LAI | | PrefixLAIForest | laif | laif | prefix | input forcings | prefix LAI forest maps | -| lfuser | PREFIXES METEO VEG VARIAB | LAI | | PrefixLAIIrrigation | laii | laii | prefix | input forcings | prefix LAI irrigation maps | -| lfuser | PREFIXES METEO VEG VARIAB | WATER USE | | PrefixWaterUseDomestic | dom | dom_2014 | prefix | input forcings | prefix domestic water use maps | -| lfuser | PREFIXES METEO VEG VARIAB | WATER USE | | PrefixWaterUseLivestock | liv | liv_2014 | prefix | input forcings | prefix livestock water use maps | -| lfuser | PREFIXES METEO VEG VARIAB | WATER USE | | PrefixWaterUseEnergy | ene | ene_2014 | prefix | input forcings | prefix energy water use maps | -| lfuser | PREFIXES METEO VEG VARIAB | WATER USE | | PrefixWaterUseIndustry | ind | ind_2014 | prefix | input forcings | prefix industry water use maps | -| lfuser | PREFIXES METEO VEG VARIAB | WATER USE | | PrefixVarWaterFraction | varw | varw | prefix | input forcings | prefix variable water fraction | -| lfuser | EVAPO(TRANSPI)RATION AND INTERCEPTION | METEO | | PrScaling | 1 | 1 | value | input par | Multiplier applied to potential precipitation rates | -| lfuser | EVAPO(TRANSPI)RATION AND INTERCEPTION | EVAPO | | CalEvaporation | 1 | 1 | value | input par | Multiplier applied to potential evapo(transpi)ration rates | -| lfuser | EVAPO(TRANSPI)RATION AND INTERCEPTION | LEAF DRAINAGE | Tint | LeafDrainageTimeConstant | 1 | 1 | value | input par | Time constant for water in interception store [days] | -| lfuser | EVAPO(TRANSPI)RATION AND INTERCEPTION | EVAPO | | kdf | 0.72 | 0.72 | value | input par | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb | -| lfuser | EVAPO(TRANSPI)RATION AND INTERCEPTION | DEPRESSION STORAGE | | SMaxSealed | 1 | 1 | value | input par | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] This storage is emptied by evaporation (EW0) | -| lfuser | SNOW AND FROST | SNOW | | SnowFactor | 1 | 1 | value | input par | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | -| lfuser | SNOW AND FROST | SNOW | | SnowSeasonAdj | 1 | 1 | value | input par | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | -| lfuser | SNOW AND FROST | SNOW | Tm | TempMelt | 1 | 1 | value | input par | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | -| lfuser | SNOW AND FROST | SNOW | | TempSnow | 1 | 1 | value | input par | It is the average temperature below which precipitation is assumed to be snow [°C] | -| lfuser | SNOW AND FROST | SNOW | | TemperatureLapseRate | 0.0065 | 0.0065 | value | input par | Temperature lapse rate with altitude [deg C / m] It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1] | -| lfuser | SNOW AND FROST | SNOW | Af | Afrost | 0.97 | 0.97 | value | input par | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | -| lfuser | SNOW AND FROST | SNOW | K | Kfrost | 0.57 | 0.57 | value | input par | Snow depth reduction coefficient, [cm-1] | -| lfuser | SNOW AND FROST | SNOW | wes | SnowWaterEquivalent | 0.45 | 0.45 | value | input par | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | -| lfuser | SNOW AND FROST | SNOW | | FrostIndexThreshold | 56 | 56 | value | input par | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | IrrigationEfficiency | 0.75 | 0.75 | value | input | Field application irrigation efficiency max 1, ~0.90 drip irrigation, ~0.75 sprinkling | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | ConveyanceEfficiency | 0.8 | 0.8 | value | input | onveyance efficiency, around 0.80 for average channel | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | IrrigationType | 1 | 1 | value | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | IrrigationMult | 1.2 | 1.2 | value | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | LivestockConsumptiveUseFraction | 0.15 | 0.15 | value | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | IndustryConsumptiveUseFraction | 0.15 | 0.15 | value | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | EnergyConsumptiveUseFraction | $(PathMaps)/energyconsumptiveuse.map | $(PathMaps)/energyconsumptiveuse.map | value/map | input | Consumptive Use (1-Recycling ratio) for energy water use (0-1) Source: Torcellini et al. (2003) "Consumptive Use for US Power Production" map advised by Neil Edwards, Energy Industry the UK and small French rivers the consumptive use varies between 1:2 and 1:3, so 0.33-0.50 For plants along big rivers like Rhine and Danube the 0.025 is ok EnergyConsumptiveUseFraction=0.025 | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | DomesticConsumptiveUseFraction | 0.2 | 0.2 | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | LeakageFraction | 0.2 | 0.2 | value | input | $(PathMaps)/leakage.map Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | LeakageWaterLoss | 0.75 | 0.75 | value | input | The water that is lost from leakage (lost) (0-1) | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | LeakageReductionFraction | 0 | 0 | value | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | WaterSavingFraction | 0 | 0 | value | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | -| lfuser | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | WaterReUseFraction | 0 | 0 | value | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | -| lfuser | INPUT WATER USE MAPS AND PAR | CALC INDICATOR | | Population | $(PathMapsLanduse)/pop | $(PathMapsLanduse)/pop | map | input | Population per pixel | -| lfuser | INPUT WATER USE MAPS AND PAR | CALC INDICATOR | | PopulationMaps | $(PathWaterUse)/pop | $(PathWaterUse)/pop | map | input | Population map for TransientLandUseChange | -| lfuser | INPUT WATER USE MAPS AND PAR | CALC INDICATOR | | LandUseMask | $(PathMaps)/lusemask.map | $(PathMaps)/lusemask.map | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | -| lfuser | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | WaterUseMaps | $(PathOut)/wuse | $(PathOut)/wuse | map | output | path and prefix of the reported water use m3 s-1 as a result of demand and availability | -| lfuser | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | WaterUseTS | $(PathOut)/wateruseUps.tss | $(PathOut)/wateruseUps.tss | tss | output | Time series of upstream water use at gauging stations | -| lfuser | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | StepsWaterUseTS | $(PathOut)/stepsWaterUse.tss | $(PathOut)/stepsWaterUse.tss | tss | output | number of loops needed for water use routine | -| lfuser | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | maxNoWateruse | 5 | 5 | value | input | maximum number of loops for calculating the use of water | -| lfuser | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | WUsePercRemain | 0.5 | 0.5 | value | input | percentage of water that must remain the channel (after water abstraction) | -| lfuser | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION / CALC INDICATOR | | WUseRegion | $(PathMaps)/wregion.map | $(PathMaps)/wregion.map | map | input | area from which surface water is extracted | -| lfuser | GROUNDWATER RELATED PAR | GROUNDWATER | | LZThreshold | $(PathMaps)/lzthreshold.map | $(PathMaps)/lzthreshold.map | map | input | threshold value below which there is no outflow to the channel | -| lfuser | GROUNDWATER RELATED PAR | GROUNDWATER | | LZSmoothRange | 5 | 5 | value | input | length of the window used to smooth the LZ zone [number of cell length] It works ONLY if wateruse=1 | -| lfuser | GROUNDWATER RELATED PAR | GROUNDWATER | | GroundwaterBodies | $(PathMaps)/gwbodiesNew.map | $(PathMaps)/gwbodiesNew.map | map | input | map of aquifers (0/1), used to smoothen LZ near extraction areas | -| lfuser | EVAPORATION FROM OPEN WATER | EVAPO | | FracMaxWater | $(PathMaps)/fracmaxwater.map | $(PathMaps)/fracmaxwater.map | map | input | Fraction of maximum extend of water | -| lfuser | EVAPORATION FROM OPEN WATER | LAKES | | LakeMask | $(PathMaps)/lakemask.map | $(PathMaps)/lakemask.map | map | input | Mask with Lakes from GLWD database | -| lfuser | TRANSMISSION LOSS | TRANSMISSION | | TransSub | 0.3 | 0.3 | value | input par | PBchange Transmission loss function parameter | -| lfuser | TRANSMISSION LOSS | TRANSMISSION | | TransPower1 | 2 | 2 | value | input par | PBchange Transmission loss function parameter | -| lfuser | TRANSMISSION LOSS | TRANSMISSION | | TransArea | 1.00E+10 | 1.00E+10 | value | input par | PBchange downstream area taking into account for transmission loss | -| lfuser | TRANSMISSION LOSS | TRANSMISSION | | UpAreaTrans | $(PathMaps)/upArea | $(PathMaps)/upArea | map | output | upstream area for transmission loss | -| lfuser | ROUTING | KINEMATIC WAVE | | beta | 0.6 | 0.6 | value | input par | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | -| lfuser | ROUTING | KINEMATIC WAVE | | OFDepRef | 5 | 5 | value | input par | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | -| lfuser | ROUTING | KINEMATIC WAVE | | GradMin | 0.001 | 0.001 | value | input par | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | -| lfuser | ROUTING | KINEMATIC WAVE | | ChanGradMin | 0.0001 | 0.0001 | value | input par | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | -| lfuser | ROUTING | MCT DIFFUSIVE WAVE | | ChannelsMCT | $(PathRoot)/maps/chanmct | $(PathRoot)/maps/chanmct | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | -| lfuser | ROUTING | MCT DIFFUSIVE WAVE | | ChanGradMaxMCT | 0.001 | 0.001 | value | input par | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) [m m-1] | -| lfuser | ROUTING | DOUBLE KINEMATIC WAVE | | QSplitMult | 2 | 2 | value | input par | PBchange Multiplier applied to average Q to split into a second line of routing | -| lfuser | NUMERICS | SOIL | | CourantCrit | 0.4 | 0.4 | value | input par | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | -| lfuser | OPTION RESERVOIR | RESERVOIRS | | DtSecReservoirs | 3600 | 3600 | value | input | Sub time step used for reservoir simulation [s]. Within the model, the smallest out of DtSecReservoirs and DtSec is used. | -| lfuser | OPTION RESERVOIR | RESERVOIRS | | ReservoirInitialFillValue | -9999 | $(PathInit)/rsfil | value/map | input initial/internal | Initial reservoir fill fraction -9999 sets initial fill to normal storage limit if you're not using the reservoir option, enter some bogus value | -| lfuser | OPTION LAKE | LAKES | | TabLakeAvNetInflowEstimate | $(PathTables)/lakeavinflow.txt | $(PathTables)/lakeavinflow.txt | table | input | Estimate of average net inflow into lake (=inflow - evaporation) [cu m / s] Used to calculated steady-state lake level in case LakeInitialLevelValue is set to -9999 | -| lfuser | OPTION POLDER | POLDER | | mu | 0.49 | 0.49 | value | input | Weir constant [-] (Do not change!) | -| lfuser | OPTION POLDER | POLDER | | PolderInitialLevelValue | 0 | 0 | value | input | Initial water level in polder [m] | -| lfuser | OPTION DYNAMIC WAVE | DYNAMIC WAVE | | CourantDynamicCrit | 0.5 | 0.5 | value | input par | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | -| lfuser | OPTION DYNAMIC WAVE | DYNAMIC WAVE | | DynWaveConstantHeadBoundary | 0 | 0 | value | input | Constant head [m] at most downstream pixel (relative to altitude at most downstream pixel) | -| lfuser | OPTION HYDROGRAPH | INFLOW | | InflowPoints | $(PathInflow)/nile_assiut.map | $(PathInflow)/nile_assiut.map | map | input forcings | OPTIONAL: nominal map with locations of (measured) inflow hydrographs [cu m / s] | -| lfuser | OPTION HYDROGRAPH | INFLOW | | QInTS | $(PathInflow)/nile_assiut.tss | $(PathInflow)/nile_assiut.tss | tss | input forcings | OPTIONAL: observed or simulated input hydrographs as time series [cu m / s] Note that identifiers in time series correspond to InflowPoints map (also optional) | -| lfuser | OPTION PF REPORTING | SOIL | | HeadMax | 1.00E+07 | 1.00E+07 | value | input | Maximum capillary head [cm]. This value is used if Theta equals residual soil moisture content (value of HeadMax is arbitrary). Only needed for pF computation, otherwise doesn't influence model results at all) | -| lfbinding | | SETTINGS | | MaskMap | $(MaskMap) | $(MaskMap) | map/value | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | -| lfbinding | | SETTINGS | | netCDFtemplate | $(netCDFtemplate) | $(netCDFtemplate) | map | input | netcdf template used to copy metadata information for writing netcdf | -| lfbinding | TIMESTEP RELATED PARAMETERS | SETTINGS | | CalendarDayStart | $(CalendarDayStart) | $(CalendarDayStart) | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. It MUST be a date as string, see code for list of available date formats. It can now include also HH:MM, if not specified they are set as 00:00 PCRaster: Day of the year of first map (e.g. xx000.001) even if the model start from map e.g. 500 e.g. 1st of January: 1; 1st of June 151 (or 152 in leap year) Needed to read out LAI tables correctly | -| lfbinding | TIMESTEP RELATED PARAMETERS | SETTINGS | | DtSec | $(DtSec) | $(DtSec) | 0 | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | -| lfbinding | TIMESTEP RELATED PARAMETERS | KINEMATIC WAVE | | DtSecChannel | $(DtSecChannel) | $(DtSecChannel) | 0 | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | -| lfbinding | TIMESTEP RELATED PARAMETERS | SETTINGS | | StepStart | $(StepStart) | $(StepStart) | value/date | input | Step id number or date of the simulation start step. See code for a list of available date formats. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | -| lfbinding | TIMESTEP RELATED PARAMETERS | SETTINGS | | StepEnd | $(StepEnd) | $(StepEnd) | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | METEO | | PrScaling | $(PrScaling) | $(PrScaling) | 0 | input | Multiplier applied to potential precipitation rates | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | EVAPO | | CalEvaporation | $(CalEvaporation) | $(CalEvaporation) | value | input | Multiplier applied to potential evapo(transpi)ration rates | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | LEAF DRAINAGE | | LeafDrainageTimeConstant | $(LeafDrainageTimeConstant) | $(LeafDrainageTimeConstant) | 0 | input | Time constant for leaf drainage | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | EVAPO | | kdf | $(kdf) | $(kdf) | value | input | ? | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | SETTINGS | | AvWaterRateThreshold | $(AvWaterRateThreshold) | $(AvWaterRateThreshold) | 0 | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | DEPRESSION STORAGE | | SMaxSealed | $(SMaxSealed) | $(SMaxSealed) | 0 | input | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] This storage is emptied by evaporation (EW0) | -| lfbinding | SNOW AND FROST | SNOW | | SnowFactor | $(SnowFactor) | $(SnowFactor) | 0 | input | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | -| lfbinding | SNOW AND FROST | SNOW | | SnowMeltCoef | $(SnowMeltCoef) | $(SnowMeltCoef) | 0 | input | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | -| lfbinding | SNOW AND FROST | SNOW | | SnowSeasonAdj | $(SnowSeasonAdj) | $(SnowSeasonAdj) | 0 | input | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | -| lfbinding | SNOW AND FROST | SNOW | | TempMelt | $(TempMelt) | $(TempMelt) | 0 | input | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | -| lfbinding | SNOW AND FROST | SNOW | | TempSnow | $(TempSnow) | $(TempSnow) | 0 | input | It is the average temperature below which precipitation is assumed to be snow [°C] | -| lfbinding | SNOW AND FROST | SNOW | | TemperatureLapseRate | $(TemperatureLapseRate) | $(TemperatureLapseRate) | 0 | input | Temperature lapse rate with altitude [deg C / m] It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1] | -| lfbinding | SNOW AND FROST | SNOW | | Afrost | $(Afrost) | $(Afrost) | 0 | input | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | -| lfbinding | SNOW AND FROST | SNOW | | Kfrost | $(Kfrost) | $(Kfrost) | 0 | input | Snow depth reduction coefficient, [cm-1] | -| lfbinding | SNOW AND FROST | SNOW | | SnowWaterEquivalent | $(SnowWaterEquivalent) | $(SnowWaterEquivalent) | 0 | input | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | -| lfbinding | SNOW AND FROST | SNOW | | FrostIndexThreshold | $(FrostIndexThreshold) | $(FrostIndexThreshold) | 0 | input | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | -| lfbinding | INFILTRATION | INFILTRATION | | b_Xinanjiang | $(b_Xinanjiang) | $(b_Xinanjiang) | 0 | input | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | -| lfbinding | INFILTRATION | INFILTRATION | | PowerPrefFlow | $(PowerPrefFlow) | $(PowerPrefFlow) | 0 | input | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | -| lfbinding | GROUNDWATER RELATED PAR | GROUNDWATER | | UpperZoneTimeConstant | $(UpperZoneTimeConstant) | $(UpperZoneTimeConstant) | 0 | input | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | -| lfbinding | GROUNDWATER RELATED PAR | GROUNDWATER | | LowerZoneTimeConstant | $(LowerZoneTimeConstant) | $(LowerZoneTimeConstant) | 0 | input | Time constant for the lower groundwater zone [days] | -| lfbinding | GROUNDWATER RELATED PAR | GROUNDWATER | | GwPercValue | $(GwPercValue) | $(GwPercValue) | 0 | input | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | -| lfbinding | GROUNDWATER RELATED PAR | GROUNDWATER | | GwLoss | $(GwLoss) | $(GwLoss) | 0 | input | Maximum loss rate out of Lower response box, expressed as a fraction of lower zone outflow. Fraction [-], range 0-1 A value of 0 (closed lower boundary) is recommended as a starting value Maximum rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. default: 0.0 | -| lfbinding | EVAPORATION FROM OPEN WATER | WATER USE | | WFractionMaps | $(PathVarWaterfraction)/$(PrefixVarWaterFraction) | $(PathVarWaterfraction)/$(PrefixVarWaterFraction) | 0 | input | water use daily maps with a (in this case negative) volume of water [cu m/s] | -| lfbinding | EVAPORATION FROM OPEN WATER | WATER USE | | WFracOfDay | $(PathTables)/WFracOfDay.txt | $(PathTables)/WFracOfDay.txt | 0 | input | table with days for each water use maps 1st column: range of days; 2nd column: suffix of wuse map | -| lfbinding | EVAPORATION FROM OPEN WATER | EVAPO | | FracMaxWater | $(FracMaxWater) | $(FracMaxWater) | value | input | Percentage of maximum extend of water | -| lfbinding | EVAPORATION FROM OPEN WATER | LAKES | | LakeMask | $(LakeMask) | $(LakeMask) | map | input | Mask with Lakes from GLWD database | -| lfbinding | EVAPORATION FROM OPEN WATER | EVAPO | | maxNoEva | 10 | 10 | value | input | ? | -| lfbinding | EVAPORATION FROM OPEN WATER | EVAPO | | EvaOpenMaps | $(PathOut)/evaop | $(PathOut)/evaop | map (missing) | output | Reported evaporation from open water [mm] | -| lfbinding | EVAPORATION FROM OPEN WATER | EVAPO | | EvaOpenTS | $(PathOut)/evaopenUps.tss | $(PathOut)/evaopenUps.tss | tss (missing) | output | Time series of upstream water evaporation from open water at gauging stations | -| lfbinding | TRANSMISSION LOSS | TRANSMISSION | | TransPower1 | $(TransPower1) | $(TransPower1) | 0 | input | PBchange Transmission loss function parameter | -| lfbinding | TRANSMISSION LOSS | TRANSMISSION | | TransSub | $(TransSub) | $(TransSub) | 0 | input | PBchange Transmission loss function parameter | -| lfbinding | TRANSMISSION LOSS | TRANSMISSION | | TransArea | $(TransArea) | $(TransArea) | 0 | input | PBchange downstream area taking into account for transmission loss | -| lfbinding | TRANSMISSION LOSS | TRANSMISSION | | UpAreaTrans | $(UpAreaTrans) | $(UpAreaTrans) | 0 | input | upstream area for transmission loss | -| lfbinding | ROUTING | KINEMATIC WAVE | | CalChanMan | $(CalChanMan) | $(CalChanMan) | 0 | input | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | -| lfbinding | ROUTING | DOUBLE KINEMATIC WAVE | | CalChanMan2 | $(CalChanMan2) | $(CalChanMan2) | value/map | input | PBchange Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | -| lfbinding | ROUTING | MCT DIFFUSIVE WAVE | | CalChanMan3 | $(CalChanMan3) | $(CalChanMan3) | value/map | input | Multiplier [-] applied to Channel Manning's n for MCT routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | -| lfbinding | ROUTING | DOUBLE KINEMATIC WAVE | | QSplitMult | $(QSplitMult) | $(QSplitMult) | value | input | PBchange Multiplier applied to average Q to split into a second line of routing | -| lfbinding | ROUTING | KINEMATIC WAVE | | beta | $(beta) | $(beta) | 0 | input | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | -| lfbinding | ROUTING | KINEMATIC WAVE | | OFDepRef | $(OFDepRef) | $(OFDepRef) | 0 | input | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | -| lfbinding | ROUTING | KINEMATIC WAVE | | GradMin | $(GradMin) | $(GradMin) | 0 | input | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | -| lfbinding | ROUTING | KINEMATIC WAVE | | ChanGradMin | $(ChanGradMin) | $(ChanGradMin) | 0 | input | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | -| lbinding | ROUTING | MCT DIFFUSIVE WAVE | | ChannelsMCT | $(ChannelsMCT) | $(ChannelsMCT) | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | -| lbinding | ROUTING | MCT DIFFUSIVE WAVE | | ChanGradMaxMCT | $(ChanGradMaxMCT) | $(ChanGradMaxMCT) | map | input | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) | -| lfbinding | NUMERICS | SOIL | | CourantCrit | $(CourantCrit) | $(CourantCrit) | value | input | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | GROUNDWATER | | LZAvInflowMap | $(PathMaps)/lzavin.map | $(PathMaps)/lzavin.map | map | input | $(PathInit)/lzavin.map Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | KINEMATIC WAVE | | AvgDis | $(PathMaps)/avgdis.map | $(PathMaps)/avgdis.map | map | input | $(PathInit)/avgdis.map CHANNEL split routing in two lines Average discharge map [m3/s] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SETTINGS | | timestepInit | $(timestepInit) | $(timestepInit) | value/date | input | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SURFACE | | OFDirectInitValue | $(OFDirectInitValue) | $(OFDirectInitValue) | value/map | input | Reported water volume for direct fraction on catchment surface [m^3] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SURFACE | | OFOtherInitValue | $(OFOtherInitValue) | $(OFOtherInitValue) | value/map | input | | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SURFACE | | OFForestInitValue | $(OFForestInitValue) | $(OFForestInitValue) | value/map | input | | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | OVERLAND FLOW | | WaterDepthInitValue | $(WaterDepthInitValue) | $(WaterDepthInitValue) | map | input | initial overland flow water depth [mm] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SNOW | | SnowCoverAInitValue | $(SnowCoverAInitValue) | $(SnowCoverAInitValue) | 0 | input | initial snow depth in snow zone A [mm] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SNOW | | SnowCoverBInitValue | $(SnowCoverBInitValue) | $(SnowCoverBInitValue) | 0 | input | initial snow depth in snow zone B [mm] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SNOW | | SnowCoverCInitValue | $(SnowCoverCInitValue) | $(SnowCoverCInitValue) | 0 | input | initial snow depth in snow zone C [mm] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SNOW | | FrostIndexInitValue | $(FrostIndexInitValue) | $(FrostIndexInitValue) | 0 | input | initial frost index value | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | INTERCEPTION | | CumIntInitValue | $(CumIntInitValue) | $(CumIntInitValue) | 0 | input | cumulative interception [mm] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | GROUNDWATER | | UZInitValue | $(UZInitValue) | $(UZInitValue) | 0 | input | water in upper groundwater zone [mm] | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SOIL | | DSLRInitValue | $(DSLRInitValue) | $(DSLRInitValue) | 0 | input | days since last rainfall | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | GROUNDWATER | | LZInitValue | $(LZInitValue) | $(LZInitValue) | 0 | input | water in lower store [mm] -9999: use steady-state storage | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | KINEMATIC WAVE | | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | $(TotalCrossSectionAreaInitValue) | 0 | input | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SOIL | | ThetaInit1Value | $(ThetaInit1Value) | $(ThetaInit1Value) | 0 | input | initial soil moisture content layer 1a -9999: use field capacity values | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SOIL | | ThetaInit2Value | $(ThetaInit2Value) | $(ThetaInit2Value) | 0 | input | initial soil moisture content layer 1b -9999: use field capacity values | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | SOIL | | ThetaInit3Value | $(ThetaInit3Value) | $(ThetaInit3Value) | 0 | input | initial soil moisture content layer 2 -9999: use field capacity values | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | DOUBLE KINEMATIC WAVE | | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | $(CrossSection2AreaInitValue) | value/map | input | initial channel crosssection for 2nd routing channel -9999: use 0 | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | DOUBLE KINEMATIC WAVE | | PrevSideflowInitValue | $(PrevSideflowInitValue) | $(PrevSideflowInitValue) | value/map | input | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | MCT DIFFUSIVE WAVE | | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | $(PrevCmMCTInitValue) | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | MCT DIFFUSIVE WAVE | | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | $(PrevDmMCTInitValue) | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | KINEMATIC WAVE | | PrevDischarge | $(PrevDischarge) | $(PrevDischarge) | 0 | input | initial discharge from previous run for MCT diffusive routing -9999: use 0 | -| lfbinding | INITIAL CONDITIONS WATER BALANCE MODEL | KINEMATIC WAVE | | PrevDischargeAvg | $(PrevDischargeAvg) | $(PrevDischargeAvg) | 0 | input | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | -| lfbinding | INITIAL CONDITION FOREST | INTERCEPTION | | CumIntForestInitValue | $(CumIntForestInitValue) | $(CumIntForestInitValue) | 0 | input | cumulative interception forest [mm] | -| lfbinding | INITIAL CONDITION FOREST | GROUNDWATER | | UZForestInitValue | $(UZForestInitValue) | $(UZForestInitValue) | 0 | input | Initial water storage water in upper groundwater zone for forest [mm] | -| lfbinding | INITIAL CONDITION FOREST | SOIL | | DSLRForestInitValue | $(DSLRForestInitValue) | $(DSLRForestInitValue) | 0 | input | initial number of days since the last rainfall event for forest [days] | -| lfbinding | INITIAL CONDITION FOREST | SOIL | | ThetaForestInit1Value | $(ThetaForestInit1Value) | $(ThetaForestInit1Value) | 0 | input | initial soil moisture content layer 1a -9999: use field capacity values | -| lfbinding | INITIAL CONDITION FOREST | SOIL | | ThetaForestInit2Value | $(ThetaForestInit2Value) | $(ThetaForestInit2Value) | 0 | input | initial soil moisture content layer 1b -9999: use field capacity values | -| lfbinding | INITIAL CONDITION FOREST | SOIL | | ThetaForestInit3Value | $(ThetaForestInit3Value) | $(ThetaForestInit3Value) | 0 | input | initial soil moisture content layer 2 -9999: use field capacity values | -| lfbinding | INITIAL CONDITION FOREST | SOIL | | CumIntSealedInitValue | $(CumIntSealedInitValue) | $(CumIntSealedInitValue) | 0 | input | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfbinding | INITIAL CONDITION IRRIGATION | INTERCEPTION | | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | $(CumIntIrrigationInitValue) | 0 | input | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfbinding | INITIAL CONDITION IRRIGATION | GROUNDWATER | | UZIrrigationInitValue | $(UZIrrigationInitValue) | $(UZIrrigationInitValue) | 0 | input | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfbinding | INITIAL CONDITION IRRIGATION | SOIL | | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | $(DSLRIrrigationInitValue) | 0 | input | initial number of days since the last rainfall event for irrigation [days] | -| lfbinding | INITIAL CONDITION IRRIGATION | SOIL | | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | $(ThetaIrrigationInit1Value) | 0 | input | initial soil moisture content layer 1a for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION IRRIGATION | SOIL | | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | $(ThetaIrrigationInit2Value) | 0 | input | initial soil moisture content layer 1b for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION IRRIGATION | SOIL | | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | $(ThetaIrrigationInit3Value) | 0 | input | initial soil moisture content layer 2 for irrigation -9999: use field capacity values | -| lfbinding | INPUT METEO AND VEG MAPS | METEO | | PrecipitationMaps | $(PathMeteo)/$(PrefixPrecipitation) | $(PathMeteo)/$(PrefixPrecipitation) | map | input | precipitation [mm/day] | -| lfbinding | INPUT METEO AND VEG MAPS | METEO | | TavgMaps | $(PathMeteo)/$(PrefixTavg) | $(PathMeteo)/$(PrefixTavg) | map | input | average daily temperature [C] | -| lfbinding | INPUT METEO AND VEG MAPS | METEO | | E0Maps | $(PathMeteo)/$(PrefixE0) | $(PathMeteo)/$(PrefixE0) | map | input | daily reference evaporation (free water) [mm/day] | -| lfbinding | INPUT METEO AND VEG MAPS | METEO | | ES0Maps | $(PathMeteo)/$(PrefixES0) | $(PathMeteo)/$(PrefixES0) | map | input | daily reference evaporation (soil) [mm/day] | -| lfbinding | 0 | METEO | | ET0Maps | $(PathMeteo)/$(PrefixET0) | $(PathMeteo)/$(PrefixET0) | map | input | daily reference evapotranspiration (crop) [mm/day] | -| lfbinding | INPUT METEO AND VEG MAPS | LAI | | LAIOtherMaps | $(PathLAI)/$(PrefixLAIOther) | $(PathLAI)/$(PrefixLAIOther) | 0 | input | leaf area index [m2/m2] | -| lfbinding | INPUT METEO AND VEG MAPS | LAI | | LAIForestMaps | $(PathLAI)/$(PrefixLAIForest) | $(PathLAI)/$(PrefixLAIForest) | 0 | input | leaf area index forest [m2/m2] | -| lfbinding | INPUT METEO AND VEG MAPS | LAI | | LAIIrrigationMaps | $(PathLAI)/$(PrefixLAIIrrigation) | $(PathLAI)/$(PrefixLAIIrrigation) | 0 | input | leaf area index irrigation [m2/m2] | -| lfbinding | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | DomesticDemandMaps | $(PathWaterUse)/$(PrefixWaterUseDomestic) | $(PathWaterUse)/$(PrefixWaterUseDomestic) | map | input | Domestic water abstraction daily maps [mm] | -| lfbinding | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | LivestockDemandMaps | $(PathWaterUse)/$(PrefixWaterUseLivestock) | $(PathWaterUse)/$(PrefixWaterUseLivestock) | map | input | Livestock water abstraction daily maps [mm] | -| lfbinding | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | EnergyDemandMaps | $(PathWaterUse)/$(PrefixWaterUseEnergy) | $(PathWaterUse)/$(PrefixWaterUseEnergy) | map | input | Energy water abstraction daily maps [mm] | -| lfbinding | INPUT WATER USE MAPS AND PAR | WATER ABSTRACTION | | IndustrialDemandMaps | $(PathWaterUse)/$(PrefixWaterUseIndustry) | $(PathWaterUse)/$(PrefixWaterUseIndustry) | map | input | Industry water abstraction daily maps [mm] | -| lfbinding | IRRIGATION AND WATER ABSTRACTION | WATER ABSTRACTION | | LivestockConsumptiveUseFraction | $(LivestockConsumptiveUseFraction) | $(LivestockConsumptiveUseFraction) | 0 | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | -| lfbinding | WATER USE MAPS AND PARAMETERS | WATER ABSTRACTION | | IndustryConsumptiveUseFraction | $(IndustryConsumptiveUseFraction) | $(IndustryConsumptiveUseFraction) | 0 | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | -| lfbinding | WATER USE MAPS AND PARAMETERS | WATER ABSTRACTION | | EnergyConsumptiveUseFraction | $(EnergyConsumptiveUseFraction) | $(EnergyConsumptiveUseFraction) | 0 | input | Consumptive Use (1-Recycling ratio) for energy production water use (0-1) | -| lfbinding | WATER USE MAPS AND PARAMETERS | WATER ABSTRACTION | | DomesticConsumptiveUseFraction | $(DomesticConsumptiveUseFraction) | $(DomesticConsumptiveUseFraction) | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | -| lfbinding | WATER USE MAPS AND PARAMETERS | WATER ABSTRACTION | | LeakageFraction | $(LeakageFraction) | $(LeakageFraction) | 0 | input | Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | LeakageWaterLoss | $(LeakageWaterLoss) | $(LeakageWaterLoss) | 0 | input | The water that is lost from leakage (lost) (0-1) | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | LeakageReductionFraction | $(LeakageReductionFraction) | $(LeakageReductionFraction) | 0 | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | WaterSavingFraction | $(WaterSavingFraction) | $(WaterSavingFraction) | 0 | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | WaterReUseFraction | $(WaterReUseFraction) | $(WaterReUseFraction) | 0 | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | IrrigationEfficiency | $(IrrigationEfficiency) | $(IrrigationEfficiency) | 0 | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | ConveyanceEfficiency | $(ConveyanceEfficiency) | $(ConveyanceEfficiency) | 0 | input | onveyance efficiency, around 0.80 for average channel | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | IrrigationType | $(IrrigationType) | $(IrrigationType) | 0 | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | IrrigationMult | $(IrrigationMult) | $(IrrigationMult) | 0 | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | -| lfbinding | WATER USE MAPS AND PAR | CROP | | MapIrrigationCropCoef | $(PathMapsTables)/cropcoef_i.map | $(PathMapsTables)/cropcoef_i.map | table | input | Irrigation crop coefficient | -| lfbinding | WATER USE MAPS AND PAR | SOIL | | MapIrrigationCropGroupNumber | $(PathMapsTables)/cropgrpn_i.map | $(PathMapsTables)/cropgrpn_i.map | table | input | Irrigation crop group number | -| lfbinding | WATER USE MAPS AND PAR | CALC INDICATOR | | Population | $(Population) | $(Population) | map | input | Population per pixel | -| lfbinding | WATER USE MAPS AND PAR | CALC INDICATOR | | PopulationMaps | $(PopulationMaps) | $(PopulationMaps) | map | input | Population map for TransientLandUseChange | -| lfbinding | WATER USE MAPS AND PAR | CALC INDICATOR | | LandUseMask | $(LandUseMask) | $(LandUseMask) | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | WaterUseMaps | $(WaterUseMaps) | $(WaterUseMaps) | map | input | Reported water use m3 s-1 depending on the availability of discharge | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | WaterUseTS | $(WaterUseTS) | $(WaterUseTS) | tss | input | Time series of upstream water use at gauging stations | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | StepsWaterUseTS | $(StepsWaterUseTS) | $(StepsWaterUseTS) | tss | input | number of loops needed for water use routine | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | maxNoWateruse | $(maxNoWateruse) | $(maxNoWateruse) | value | input | maximum number of loops for calculating the use of water (=distance to the water demand cell) | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION | | WUsePercRemain | $(WUsePercRemain) | $(WUsePercRemain) | value | input | percentage of water that must remain in a grid cell and is not withdrawn by water use e.g. 0.2 = 20 percent of discharge is not taken out | -| lfbinding | WATER USE MAPS AND PAR | WATER ABSTRACTION / CALC INDICATOR | | WUseRegion | $(WUseRegion) | $(WUseRegion) | map | input | water use region | -| lfbinding | RICE IRRIGATION | RICE IRRIGATION | | RiceFlooding | 10 | 10 | 0 | input | water amount in mm per day 10 mm for 10 days (total 10cm water) | -| lfbinding | RICE IRRIGATION | RICE IRRIGATION | | RicePercolation | 2 | 2 | 0 | input | FAO: percolation for heavy clay soils: PERC = 2 mm/day | -| lfbinding | RICE IRRIGATION | RICE IRRIGATION | | RicePlantingDay1 | $(PathMapsTables)/riceplantingday1.map | $(PathMapsTables)/riceplantingday1.map | table | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RICE IRRIGATION | | RiceHarvestDay1 | $(PathMapsTables)/riceharvestday1.map | $(PathMapsTables)/riceharvestday1.map | map | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RICE IRRIGATION | | RicePlantingDay2 | $(PathMapsTables)/riceplantingday2.map | $(PathMapsTables)/riceplantingday2.map | table | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RICE IRRIGATION | | RiceHarvestDay2 | $(PathMapsTables)/riceharvestday2.map | $(PathMapsTables)/riceharvestday2.map | map | input | map with starting day of the year | -| lfbinding | REPORTED OUTPUT MAPS | ROUTING | | DischargeMaps | $(PathOut)/dis | $(PathOut)/dis | map | output | Reported average discharge [cu m/s] (average over model timestep) | -| lfbinding | REPORTED OUTPUT MAPS | SOIL | | TopSoilMoistureMaps | $(PathOut)/wt | $(PathOut)/wt | map (missing) | output | Reported Topsoil moisture [%] | -| lfbinding | REPORTED OUTPUT MAPS | SOIL | | SurfaceSoilMoistureMaps | $(PathOut)/wta | $(PathOut)/wta | map (missing) | output | Reported surface soil moisture [%] | -| lfbinding | REPORTED OUTPUT MAPS | KINEMATIC WAVE | | DisMaps | $(PathOut)/q | $(PathOut)/q | map (missing) | output | Reported discharge [cu m/s] at the end of a timestep | -| lfbinding | REPORTED OUTPUT MAPS | KINEMATIC WAVE | | MaskDischargeMaps | $(PathOut)/dism | $(PathOut)/dism | map (missing) | output | Reported discharge [cu m/s] but cut by a discharge mask map | -| lfbinding | REPORTED OUTPUT MAPS | KINEMATIC WAVE | | WaterLevelMaps | $(PathOut)/wl | $(PathOut)/wl | map | output | Reported water level [m] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta1State | $(PathOut)/tha | $(PathOut)/tha | map | output/state | Reported volumetric soil moisture content for soil layer 1 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta2State | $(PathOut)/thb | $(PathOut)/thb | map | output/state | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta3State | $(PathOut)/thc | $(PathOut)/thc | map | output/state | Reported volumetric soil moisture content for both soil layer 3 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | GROUNDWATER | | UZState | $(PathOut)/uz | $(PathOut)/uz | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | GROUNDWATER | | LZState | $(PathOut)/lz | $(PathOut)/lz | map | output/state | Reported storage in lower response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | DSLRState | $(PathOut)/dslr | $(PathOut)/dslr | map | output/state | Reported days since last rain [ndays] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ROUTING | | WaterDepthState | $(PathOut)/wdept | $(PathOut)/wdept | map | output | Reported overland flow water depth | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SURFACE | | OFDirectState | $(PathOut)/ofdir | $(PathOut)/ofdir | map | output/state | Reported water volume for direct fraction on catchment surface [m3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SURFACE | | OFOtherState | $(PathOut)/ofoth | $(PathOut)/ofoth | map | output/state | Reported water volume for other fraction on catchment surface [m3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SURFACE | | OFForestState | $(PathOut)/offor | $(PathOut)/offor | map | output/state | Reported water volume for forest fraction on catchment surface [m3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | KINEMATIC WAVE | | ChanCrossSectionState | $(PathOut)/chcro | $(PathOut)/chcro | map | output/state | Reported chan cross-section area [m2] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SNOW | | SnowCoverAState | $(PathOut)/scova | $(PathOut)/scova | map | output/state | Reported snow cover in snow zone A [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SNOW | | SnowCoverBState | $(PathOut)/scovb | $(PathOut)/scovb | map | output/state | Reported snow cover in snow zone B [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SNOW | | SnowCoverCState | $(PathOut)/scovc | $(PathOut)/scovc | map | output/state | Reported snow cover in snow zone C [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SNOW | | FrostIndexState | $(PathOut)/frost | $(PathOut)/frost | map | output/state | Reported frost index | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | INTERCEPTION | | CumInterceptionState | $(PathOut)/cum | $(PathOut)/cum | map | output/state | Reported interception storage | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DOUBLE KINEMATIC WAVE | | CrossSection2State | $(PathOut)/ch2cr | $(PathOut)/ch2cr | map | output/state | Cross section area for split routing [m2] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DOUBLE KINEMATIC WAVE | | ChSideState | $(PathOut)/chside | $(PathOut)/chside | map | output/state | Reported sideflow to channel for first line of routing [m3/s] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ROUTING | | ChanQState | $(PathOut)/chanq | $(PathOut)/chanq | map | output/state | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ROUTING | | ChanQAvgDtState | $(PathOut)/chanqavgdt | $(PathOut)/chanqavgdt | map | output/state | Reported average discharge the last routing sub-step [cu m/s] ChanQAvgDt | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ROUTING | | PrevCmMCTState | $(PathOut)/prevcm | $(PathOut)/prevcm | map | output/state | Reported Courant number at previous step for MCT routing | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ROUTING | | PrevDmMCTState | $(PathOut)/prevdm | $(PathOut)/prevdm | map | output/state | Reported Reynolds number at previous step for MCT routing | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | DSLRForestState | $(PathOut)/dslf | $(PathOut)/dslf | map | output/state | Reported days since last rain for forest | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | INTERCEPTION | | CumInterceptionForestState | $(PathOut)/cumf | $(PathOut)/cumf | map | output/state | Reported interception storage for forest | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta1ForestState | $(PathOut)/thfa | $(PathOut)/thfa | map | output/state | theta for soil layer 1a forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta2ForestState | $(PathOut)/thfb | $(PathOut)/thfb | map | output/state | theta for soil layer 1b forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta3ForestState | $(PathOut)/thfc | $(PathOut)/thfc | map | output/state | theta for soil layer 2 forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | GROUNDWATER | | UZForestState | $(PathOut)/uzf | $(PathOut)/uzf | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SURFACE | | CumIntSealedState | $(PathOut)/cseal | $(PathOut)/cseal | map | output/state | Reported depression storage | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | DSLRIrrigationState | $(PathOut)/dsli | $(PathOut)/dsli | map | output/state | Reported days since last rain irrigation | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | INTERCEPTION | | CumInterceptionIrrigationState | $(PathOut)/cumi | $(PathOut)/cumi | map | output/state | Reported interception storage | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta1IrrigationState | $(PathOut)/thia | $(PathOut)/thia | map | output/state | Reported volumetric soil moisture content for soil layer 1a for irrigation[V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta2IrrigationState | $(PathOut)/thib | $(PathOut)/thib | map | output/state | Reported volumetric soil moisture content for both soil layer 1b for irrigation [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SOIL | | Theta3IrrigationState | $(PathOut)/thic | $(PathOut)/thic | map | output/state | Reported volumetric soil moisture content for both soil layer 2 for irrigation [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | GROUNDWATER | | UZIrrigationState | $(PathOut)/uzi | $(PathOut)/uzi | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta1End | $(PathOut)/tha.end | $(PathOut)/tha.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta2End | $(PathOut)/thb.end | $(PathOut)/thb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta3End | $(PathOut)/thc.end | $(PathOut)/thc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | GROUNDWATER | | UZEnd | $(PathOut)/uz.end | $(PathOut)/uz.end | map | output/end | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | GROUNDWATER | | LZEnd | $(PathOut)/lz.end | $(PathOut)/lz.end | map | output/end | Reported storage in lower groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | DSLREnd | $(PathOut)/dslr.end | $(PathOut)/dslr.end | map | output/end | Reported days since last rain | -| lfbinding | REPORTED OUTPUT MAPS (END) | ROUTING | | WaterDepthEnd | $(PathOut)/wdept.end | $(PathOut)/wdept.end | map | output/end | Reported overlandflow water depth | -| lfbinding | REPORTED OUTPUT MAPS (END) | SURFACE | | OFDirectEnd | $(PathOut)/ofdir.end | $(PathOut)/ofdir.end | map | output/end | Reported water volume for direct fraction on catchment surface | -| lfbinding | REPORTED OUTPUT MAPS (END) | SURFACE | | OFOtherEnd | $(PathOut)/ofoth.end | $(PathOut)/ofoth.end | map | output/end | | -| lfbinding | REPORTED OUTPUT MAPS (END) | SURFACE | | OFForestEnd | $(PathOut)/offor.end | $(PathOut)/offor.end | map | output/end | | -| lfbinding | REPORTED OUTPUT MAPS (END) | KINEMATIC WAVE | | ChanCrossSectionEnd | $(PathOut)/chcro.end | $(PathOut)/chcro.end | map | output/end | Reported chan cross-section area | -| lfbinding | REPORTED OUTPUT MAPS (END) | SNOW | | SnowCoverAEnd | $(PathOut)/scova.end | $(PathOut)/scova.end | map | output/end | Reported snow cover in snow zone A [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SNOW | | SnowCoverBEnd | $(PathOut)/scovb.end | $(PathOut)/scovb.end | map | output/end | Reported snow cover in snow zone B [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SNOW | | SnowCoverCEnd | $(PathOut)/scovc.end | $(PathOut)/scovc.end | map | output/end | Reported snow cover in snow zone C [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SNOW | | FrostIndexEnd | $(PathOut)/frost.end | $(PathOut)/frost.end | map | output/end | Reported frost index | -| lfbinding | REPORTED OUTPUT MAPS (END) | INTERCEPTION | | CumInterceptionEnd | $(PathOut)/cum.end | $(PathOut)/cum.end | map | output/end | Reported interception storage | -| lfbinding | REPORTED OUTPUT MAPS (END) | LAKES | | LakeLevelEnd | $(PathOut)/lakeh.end | $(PathOut)/lakeh.end | map | output/end | Reported lake level | -| lfbinding | REPORTED OUTPUT MAPS (END) | LAKES | | LakeStorageM3 | $(PathOut)/lakest | $(PathOut)/lakest | map | output | Reported lake storage | -| lfbinding | REPORTED OUTPUT MAPS (END) | RESERVOIRS | | ReservoirFillEnd | $(PathOut)/rsfil.end | $(PathOut)/rsfil.end | map | output/end | Reported reservoir filling | -| lfbinding | REPORTED OUTPUT MAPS (END) | DOUBLE KINEMATIC WAVE | | CrossSection2End | $(PathOut)/ch2cr.end | $(PathOut)/ch2cr.end | map | output/end | Cross section area for split routing [m2] | -| lfbinding | REPORTED OUTPUT MAPS (END) | DOUBLE KINEMATIC WAVE | | ChSideEnd | $(PathOut)/chside.end | $(PathOut)/chside.end | map | output/end | Reported channel side flow | -| lfbinding | REPORTED OUTPUT MAPS (END) | ROUTING | | ChanQEnd | $(PathOut)/chanq.end | $(PathOut)/chanq.end | map | output/end | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | -| lfbinding | REPORTED OUTPUT MAPS (END) | ROUTING | | ChanQAvgDtEnd | $(PathOut)/chanqavgdt.end | $(PathOut)/chanqavgdt.end | map | output/end | Reported average discharge on the last routing sub-step [cu m/s] ChanQAvgDt | -| lfbinding | REPORTED OUTPUT MAPS (END) | KINEMATIC WAVE | | DischargeEnd | $(PathOut)/dis.end | $(PathOut)/dis.end | map | output/end | Reported average discharge on the model timestep [m3/s] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ROUTING | | PrevCmMCTEnd | $(PathOut)/prevcm.end | $(PathOut)/prevcm.end | map | output/end | Reported Courant number at previous step for MCT routing | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ROUTING | | PrevDmMCTEnd | $(PathOut)/prevdm.end | $(PathOut)/prevdm.end | map | output/end | Reported Raynolds number at previous step for MCT routing | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | DSLRForestEnd | $(PathOut)/dslf.end | $(PathOut)/dslf.end | map | output/end | Reported days since last rain for forest | -| lfbinding | REPORTED OUTPUT MAPS (END) | INTERCEPTION | | CumInterceptionForestEnd | $(PathOut)/cumf.end | $(PathOut)/cumf.end | map | output/end | Reported interception storage for forest | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta1ForestEnd | $(PathOut)/thfa.end | $(PathOut)/thfa.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a for forest [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta2ForestEnd | $(PathOut)/thfb.end | $(PathOut)/thfb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b for forest [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta3ForestEnd | $(PathOut)/thfc.end | $(PathOut)/thfc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | GROUNDWATER | | UZForestEnd | $(PathOut)/uzf.end | $(PathOut)/uzf.end | map | output/end | Reported storage in upper groundwaterzone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SURFACE | | CumIntSealedEnd | $(PathOut)/cseal.end | $(PathOut)/cseal.end | map | output/end | Reported depression storage | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | DSLRIrrigationEnd | $(PathOut)/dsli.end | $(PathOut)/dsli.end | map | output/end | Reported days since last rain for irrigation | -| lfbinding | REPORTED OUTPUT MAPS (END) | INTERCEPTION | | CumInterceptionIrrigationEnd | $(PathOut)/cumi.end | $(PathOut)/cumi.end | map | output/end | Reported interception storage for irrigation | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta1IrrigationEnd | $(PathOut)/thia.end | $(PathOut)/thia.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta2IrrigationEnd | $(PathOut)/thib.end | $(PathOut)/thib.end | map | output/end | Reported volumetric soil moisture content for soil layer 1b [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SOIL | | Theta3IrrigationEnd | $(PathOut)/thic.end | $(PathOut)/thic.end | map | output/end | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | GROUNDWATER | | UZIrrigationEnd | $(PathOut)/uzi.end | $(PathOut)/uzi.end | map | output/end | Reported storage in upper groundwater zone response box for irrigation [mm] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | METEO | | PrecipitationMapsOut | $(PathOut)/pr | $(PathOut)/pr | map | output | Precipitation [mm per time step] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | METEO | | TavgMapsOut | $(PathOut)/tav | $(PathOut)/tav | map | output | Average DAILY temperature [degrees C] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EVAPO | | ETRefMapsOut | $(PathOut)/et | $(PathOut)/et | map | output | Potential reference evapotranspiration [mm per time step] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EVAPO | | ESRefMapsOut | $(PathOut)/es | $(PathOut)/es | map | output | Potential evaporation from bare soil surface [mm per time step] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EVAPO | | EWRefMapsOut | $(PathOut)/ew | $(PathOut)/ew | map | output | Potential evaporation from open water surface [mm per time step] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | SOIL | | Theta1Maps | $(PathOut)/thtop | $(PathOut)/thtop | map | output | Reported volumetric soil moisture content for soil layer 1 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | GROUNDWATER | | UZOutflowMaps | $(PathOut)/quz | $(PathOut)/quz | map | output | Reported upper groundwater zone outflow [mm/∆t] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | RUNOFF | | TotaltoChanMaps | $(PathOut)/ttoc | $(PathOut)/ttoc | map | output | Reported total runoff that enters the channel: groundwater + surface runoff [mm/∆t] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | GROUNDWATER | | UZMaps | $(PathOut)/uz | $(PathOut)/uz | map | output | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | GROUNDWATER | | LZMaps | $(PathOut)/lz | $(PathOut)/lz | map | output | Reported storage in lower groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | SOIL | | DSLRMaps | $(PathOut)/dslr | $(PathOut)/dslr | map | output | Reported days since last rain | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | ROUTING | | WaterDepthMaps | $(PathOut)/wdept | $(PathOut)/wdept | map | output | Reported water depth | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | RUNOFF | | TotalRunoffMaps | $(PathOut)/trun | $(PathOut)/trun | map | output | Reported total runoff [mm/∆t] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | SOIL | | Theta3Maps | $(PathOut)/thbot | $(PathOut)/thbot | map | output | Reported volumetric soil moisture content for soil layer 2 [V/V] | +##**Table:** *LISFLOOD Settings: lfoptions.* +The table below presents the ist of available switches to activate optional modules and optional outputs (time series and map formats). For each option, 1 = ON; 0 = OFF. Deault staus is 0 = OFF, unless otherwise indicated in the table. +| section (XML) | module | KEY | Type | I/O | Description | +|:------------------------|:-------------------------------------------|:----------------------------------------|:--------------------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| --------------- | ------------------------------------ | --------------------------------- | --------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| lfoptions | SETTINGS | TemperatureInKelvin | switch (1 or 0) | | Use temperature data in C (=0) or in K (=1) | +| lfoptions | SETTINGS | gridSizeUserDefined | switch (1 or 0) | | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | +| lfoptions | INFLOW | inflow | switch (1 or 0) | | Use inflow hydrographs | +| lfoptions | SOIL | simulatePF | switch (1 or 0) | | Calculate pF values from soil moisture | +| lfoptions | LAKES | simulateLakes | switch (1 or 0) | | Simulate unregulated lakes | +| lfoptions | RESERVOIRS | simulateReservoirs | switch (1 or 0) | | Simulate reservoirs | +| lfoptions | LANDUSE CHANGE | TransientLandUseChange | switch (1 or 0) | | Activate reading of time changing land use description | +| lfoptions | WATER ABSTRACTION | TransientWaterDemandChange | switch (1 or 0) | | Activate reading of time changing water demand | +| lfoptions | WATER ABSTRACTION | useWaterDemandAveYear | switch (1 or 0) | | Use "average" year for water demand and loop it over years | +| lfoptions | TRANSMISSION LOSS | TransLoss | switch (1 or 0) | | Activate transmission loss | +| lfoptions | DOUBLE KINEMATIC WAVE | SplitRouting | switch (1 or 0) | | Activate double kinematic wave routing | +| lfoptions | MCT DIFFUSIVE WAVE | MCTRouting | switch (1 or 0) | | Activate MCT diffusive wave routing | +| lfoptions | WATER ABSTRACTION | wateruse | switch (1 or 0) | | Activate water use computation | +| lfoptions | GROUNDWATER | groundwaterSmooth | switch (1 or 0) | | Activate smoothing for groundwater | +| lfoptions | WATER ABSTRACTION | wateruseRegion | switch (1 or 0) | | Use water regions in water use module | +| lfoptions | IRRIGATION | drainedIrrigation | switch (1 or 0) | | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | +| lfoptions | IRRIGATION | riceIrrigation | switch (1 or 0) | | Activate computation for paddy rice irrigation and abstraction | +| lfoptions | EVAPO | openwaterevapo | switch (1 or 0, default = 1) | | Compute evaporation from open water | +| lfoptions | INDICATOR | indicator | switch (1 or 0) | | Activate computation of indicators (such as WEI, e-flow, etc) | +| lfoptions | SETTINGS | InitLisflood | switch (1 or 0) | | Run LISFLOOD initialization run | +| lfoptions | SETTINGS | InitLisfloodwithoutSplit | switch (1 or 0) | | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | +| lfoptions | SETTINGS | ColdStart | switch (1 or 0, default = 1) | | Run LISFLOOD Cold Start | +| lfoptions | IO | readNetcdfStack | switch (1 or 0) | | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | +| lfoptions | IO | writeNetcdfStack | switch (1 or 0) | | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | +| lfoptions | IO | writeNetcdf | switch (1 or 0) | | Write NetCDF files for END files (single netcdf) | +| lfoptions | DISCHARGE | repDischargeTs | switch (1 or 0, default = 1) rep tss | output | Report discharge time series at gauges | +| lfoptions | LOG | repMBTs | switch (1 or 0) rep tss | output | Report timeseries of absolute cumulative mass balance error | +| lfoptions | STATE | repStateSites | switch (1 or 0) rep tss | output | Report state variables at sites | +| lfoptions | STATE | repRateSites | switch (1 or 0) rep tss | output | Report state variables rates at sites | +| lfoptions | STATE | repStateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model variables, averaged over contributing area of each gauging station | +| lfoptions | STATE | repRateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model rate variables, averaged over contributing area of each gauging station | +| lfoptions | METEO | repMeteoUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of meteo input data | +| lfoptions | WATER ABSTRACTION | repwateruseGauges | switch (1 or 0) rep tss | output | Report water use ts at gauges | +| lfoptions | WATER ABSTRACTION | repwateruseSites | switch (1 or 0) rep tss | output | Report water use ts at sistes | +| lfoptions | SOIL | repPFUpsGauges | switch (1 or 0) rep tss | output | Report PF ts at gauges | +| lfoptions | SOIL | repPFSites | switch (1 or 0) rep tss | output | Report PF ts at sistes | +| lfoptions | LAKES | repsimulateLakes | switch (1 or 0) rep tss | output | Report time series of lakes | +| lfoptions | RESERVOIRS | repsimulateReservoirs | switch (1 or 0) rep tss | output | Report time series of reservoirs | +| lfoptions | LOG | repBal1 | switch (1 or 0) rep tss | output | Report water balance TS | +| lfoptions | STATE | repStateMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (as defined by "ReportSteps" variable) | +| lfoptions | STATE | repEndMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (at last time step) | +| lfoptions | METEO | repPrecipitationMaps | switch (1 or 0) rep maps | output | Report precipitation | +| lfoptions | METEO | repTavgMaps | switch (1 or 0) rep maps | output | Report average temperature maps | +| lfoptions | EVAPO | repETRefMaps | switch (1 or 0) rep maps | output | Report reference evapo-transpiration | +| lfoptions | EVAPO | repESRefMaps | switch (1 or 0) rep maps | output | Report reference soil evaporation | +| lfoptions | EVAPO | repEWRefMaps | switch (1 or 0) rep maps | output | Report reference evaporation of intercepted water | +| lfoptions | ROUTING | repChanCrossSectionMaps | switch (1 or 0) rep maps | output | Report total cross-section area for channels | +| lfoptions | INTERCEPTION | repCumInterCeptionMaps | switch (1 or 0) rep maps | output | Report cumulative interception | +| lfoptions | DISCHARGE | repDischargeMaps | switch (1 or 0) rep maps | output | Report maps of discharge (for each time step) | +| lfoptions | METEO | repDSLRMaps | switch (1 or 0) rep maps | output | Report maps with number of days since the last rainfall event | +| lfoptions | EVAPO | repESActMaps | switch (1 or 0) rep maps | output | Report actual soil evaporation | +| lfoptions | EVAPO | repEWIntMaps | switch (1 or 0) rep maps | output | Report evaporation of intercepted water | +| lfoptions | SNOW | repFrostIndexMaps | switch (1 or 0) rep maps | output | Report frost index maps | +| lfoptions | GROUNDWATER | repGwLossMaps | switch (1 or 0) rep maps | output | Report groundwater loss maps and trransmission loss maps (the later if the module TransLoss is active) | +| lfoptions | GROUNDWATER | repGwPercUZLZMaps | switch (1 or 0) rep maps | output | Report maps of percolation from upper to lower ground water zone (for each time step) | +| lfoptions | INFILTRATION | repInfiltrationMaps | switch (1 or 0) rep maps | output | Report infiltration maps | +| lfoptions | INTERCEPTION | repInterceptionMaps | switch (1 or 0) rep maps | output | Report interception maps | +| lfoptions | LEAF | repLeafDrainageMaps | switch (1 or 0) rep maps | output | Report leaf drainage maps | +| lfoptions | GROUNDWATER | repLZAvInflowMap | switch (1 or 0) rep maps | output | Report lower groundwater zone inflow maps | +| lfoptions | GROUNDWATER | repLZMaps | switch (1 or 0) rep maps | output | Report maps of lower groundwater zone storage (for each time step) | +| lfoptions | GROUNDWATER | repLZOutflowMaps | switch (1 or 0) rep maps | output | Report lower groundwater zone outflow maps | +| lfoptions | PERCOLATION | repPercolationMaps | switch (1 or 0) rep maps | output | Report percolation maps | +| lfoptions | SOIL | repPFMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture | +| lfoptions | SOIL | repPFForestMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture for forest fraction | +| lfoptions | SOIL | repPrefFlowMaps | switch (1 or 0) rep maps | output | Report preferential flow (rapid bypass soil matrix) | +| lfoptions | METEO | repRainMaps | switch (1 or 0) rep maps | output | Report rain excluding snow | +| lfoptions | GROUNDWATER | repSeepSubToGWMaps | switch (1 or 0) rep maps | output | Report flux between sub soil and GW | +| lfoptions | SNOW | repSnowCoverMaps | switch (1 or 0) rep maps | output | Report maps of snow cover (for each time step) | +| lfoptions | SNOW | repSnowMaps | switch (1 or 0) rep maps | output | Report maps of snow (for each time step) | +| lfoptions | SNOW | repSnowMeltMaps | switch (1 or 0) rep maps | output | Report maps of snowmelt (for each time step) | +| lfoptions | SURFACE | repSurfaceRunoffMaps | switch (1 or 0) rep maps | output | Report maps of surface runoff (for each time step) | +| lfoptions | TRANSPIRATION | repTaMaps | switch (1 or 0) rep maps | output | Report transpiration maps | +| lfoptions | SOIL | repThetaMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA | +| lfoptions | SOIL | repThetaForestMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA FOREST | +| lfoptions | SOIL | repThetaIrrigationMaps | switch (1 or 0) rep maps | output | Report irrigation mapsrE | +| lfoptions | SOIL | repTotalRunoffMaps | switch (1 or 0) rep maps | output | Report total runoff | +| lfoptions | GROUNDWATER | repUZMaps | switch (1 or 0) rep maps | output | Report maps of upper groundwater zone storage (for each time step) | +| lfoptions | GROUNDWATER | repUZOutflowMaps | switch (1 or 0) rep maps | output | Report maps for upper groundwater zone outflow | +| lfoptions | ROUTING | repWaterDepthMaps | switch (1 or 0) rep maps | output | Report water depth on soil surface | +| lfoptions | EVAPO | ETActMaps | switch (1 or 0) rep maps | output | Report actual evapo-transpiration | +| lfoptions | ROUTING | repFastRunoffMaps | switch (1 or 0) rep maps | output | Report fast runoff = surface + UZ | +| lfoptions | WATER STRESS | repRWS | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP | +| lfoptions | WATER STRESS | repStressDays | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP for forest | +| lfoptions | SOIL | repPF1Maps | switch (1 or 0) rep maps | output | Report PF1 maps | +| lfoptions | SOIL | repPF2Maps | switch (1 or 0) rep maps | output | Report PF2 maps | +| lfoptions | WATER ABSTRACTION | repTotalAbs | switch (1 or 0) rep maps | output | Report total water abstraction | +| lfoptions | WATER ABSTRACTION | repTotalWUse | switch (1 or 0) rep maps | output | Report total water use | +| lfoptions | INDICATOR | repWIndex | switch (1 or 0) rep maps | output | Report indexes and indicators | -**Table:** *Switches for LISFLOOD options.* -| section (XML) | group (XML) | module | Eqz. | key | default | module | Type | I/O | DEFAULT | cold | warm | calib | Description | -| --------------- | ----------- | ------ | ---- | -------------------------- | ------- | ----------------- | --------------- | ----- | ------- | ---- | ---- | ----- |-----------------------------------------------------------------------------------------------------------------------------------------------| -| lfoptions | | | | TemperatureInKelvin | 0 | SETTINGS | switch | input | 0 | | | | Use temperature data in C (=0) or in K (=1) | -| lfoptions | | | | gridSizeUserDefined | 0 | SETTINGS | switch | input | 0 | | | | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | -| lfoptions | | | | dynamicWave | 0 | DYNAMIC WAVE | switch | input | 0 | | | | Activate dynamic wave routing | -| lfoptions | | | | inflow | 0 | INFLOW | switch | input | 0 | | | | Use inflow hydrographs | -| lfoptions | | | | simulatePF | 0 | SOIL | switch | input | 0 | | | | Calculate pF values from soil moisture | -| lfoptions | | | | simulateLakes | 0 | LAKES | switch | input | 0 | | | | Simulate unregulated lakes (kin. wave only) | -| lfoptions | | | | simulatePolders | 0 | POLDERS | switch | input | 0 | | | | Simulate polders (dyn. wave only) | -| lfoptions | | | | simulateReservoirs | 0 | RESERVOIRS | switch | input | 0 | | | | Simulate retention and hydropower reservoirs (kin. wave only) | -| lfoptions | | | | simulateWaterLevels | 0 | WATER LEVELS | switch | input | 0 | | | | Activate computation of water level maps / time series (does not affect routing) | -| lfoptions | | | | TransientLandUseChange | 0 | LANDUSE CHANGE | switch | input | 0 | | | | Activate reading of time changing land use description | -| lfoptions | | | | TransientWaterDemandChange | 0 | WATER ABSTRACTION | switch | input | 0 | | | | Activate reading of time changing water demand | -| lfoptions | | | | useWaterDemandAveYear | 0 | WATER ABSTRACTION | switch | input | 0 | | | | Use "average" year for water demand and loop it over years | -| lfoptions | | | | TransLoss | 0 | TRANSMISSION LOSS | switch | input | 0 | | | | Activate transmission loss | -| lfoptions | | | | SplitRouting | 0 | KINEMATIC WAVE | switch | input | 0 | | | | Activate double kinematic wave routing | -| lfoptions | | | | MCTRouting | 0 | MCT DIFFUSIVE WAVE| switch | input | 0 | | | | Activate MCT diffusive wave routing | -| lfoptions | | | | wateruse | 0 | WATER ABSTRACTION | switch | input | 0 | | | | Activate water use computation | -| lfoptions | | | | groundwaterSmooth | 0 | GROUNDWATER | switch | input | 0 | | | | Activate smoothing for groundwater to correct error by using windowtotal, based on groundwater bodies and catchments | -| lfoptions | | | | wateruseRegion | 0 | WATER ABSTRACTION | switch | input | 0 | | | | Use water regions in water use module | -| lfoptions | | | | drainedIrrigation | 0 | IRRIGATION | switch | input | 0 | | | | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | -| lfoptions | | | | riceIrrigation | 0 | IRRIGATION | switch | input | 0 | | | | Activate computation for paddy rice irrigation and abstraction | -| lfoptions | | | | openwaterevapo | 1 | EVAPO | switch | input | 1 | | | | Compute evaporation from open water | -| lfoptions | | | | varfractionwater | 0 | EVAPO | switch | input | 0 | | | | Compute the fraction of pixel that is open water | -| lfoptions | | | | indicator | 0 | INDICATOR | switch | input | 0 | | | | Activate computation of indicators (such as WEI, e-flow, etc) | -| lfoptions | | | | MonteCarlo | 0 | SETTINGS | switch | input | 0 | | | | Activate MonteCarlo simulation | -| lfoptions | | | | EnKF | 0 | SETTINGS | switch | input | 0 | | | | Activate EnKF simulation | -| lfoptions | | | | InitLisflood | 1 | SETTINGS | switch | input | 1 | | | | Run LISFLOOD initialization run | -| lfoptions | | | | InitLisfloodwithoutSplit | 0 | SETTINGS | switch | input | 0 | | | | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | -| lfoptions | | | | readNetcdfStack | 0 | IO | switch | input | 0 | | | | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | -| lfoptions | | | | writeNetcdfStack | 0 | IO | switch | input | 0 | | | | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | -| lfoptions | | | | writeNetcdf | 0 | IO | switch | input | 0 | | | | Write NetCDF files for END files (single netcdf) | -| lfoptions | | | | repDischargeTs | 1 | DISCHARGE | switch rep tss | input | 1 | | | | Report average discharge time series at gauges | -| lfoptions | | | | repInternalCom | 0 | LOG | switch rep tss | input | 0 | | | | Report internal number of sub step for soil, channel routing, water use | -| lfoptions | | | | repMBTs | 0 | LOG | switch rep tss | input | 0 | | | | Report timeseries of absolute cumulative mass balance error | -| lfoptions | | | | repStateSites | 0 | STATE | switch rep tss | input | 0 | | | | Report state variables at sites | -| lfoptions | | | | repRateSites | 0 | STATE | switch rep tss | input | 0 | | | | Report state variables rates at sites | -| lfoptions | | | | repStateUpsGauges | 0 | STATE | switch rep tss | input | 0 | | | | Report timeseries of model variables, averaged over contributing area of each gauging station | -| lfoptions | | | | repRateUpsGauges | 0 | STATE | switch rep tss | input | 0 | | | | Report timeseries of model rate variables, averaged over contributing area of each gauging station | -| lfoptions | | | | repMeteoUpsGauges | 0 | METEO | switch rep tss | input | 0 | | | | Report timeseries of meteo input data | -| lfoptions | | | | repLZAvInflowSites | 0 | INFLOW | switch rep tss | input | 0 | | | | Report time serie of average percolation rate from upper to lower groundwater zone at sites | -| lfoptions | | | | repLZAvInflowUpsGauges | 0 | INFLOW | switch rep tss | input | 0 | | | | Report time serie of average percolation rate from upper to lower groundwater zone at gauges | -| lfoptions | | | | repwateruseGauges | 0 | WATER ABSTRACTION | switch rep tss | input | 0 | | | | Report water use ts at gauges | -| lfoptions | | | | repwateruseSites | 0 | WATER ABSTRACTION | switch rep tss | input | 0 | | | | Report water use ts at sistes | -| lfoptions | | | | repWaterLevelTs | 0 | WATER LEVELS | switch rep tss | input | 0 | | | | Report water level ts | -| lfoptions | | | | repPFUpsGauges | 0 | SOIL | switch rep tss | input | 0 | | | | Report PF ts at gauges | -| lfoptions | | | | repPFSites | 0 | SOIL | switch rep tss | input | 0 | | | | Report PF ts at sistes | -| lfoptions | | | | repsimulateLakes | 0 | LAKES | switch rep tss | input | 0 | | | | Report time series of lakes | -| lfoptions | | | | repsimulateReservoirs | 0 | RESERVOIRS | switch rep tss | input | 0 | | | | Report time series of reservoirs | -| lfoptions | | | | repsimulatePolders | 0 | POLDERS | switch rep tss | input | 0 | | | | Report time series of polders | -| lfoptions | | | | repBal1 | 0 | LOG | switch rep tss | input | 0 | | | | Report water balance TS | -| lfoptions | | | | repStateMaps | 1 | STATE | switch rep maps | input | 1 | | | | Report maps of model state variables (as defined by "ReportSteps" variable) | -| lfoptions | | | | repEndMaps | 1 | STATE | switch rep maps | input | 1 | | | | Report maps of model state variables (at last time step) | -| lfoptions | | | | repPrecipitationMaps | 0 | METEO | switch rep maps | input | 0 | | | | Report precipitation | -| lfoptions | | | | repTavgMaps | 0 | METEO | switch rep maps | input | 0 | | | | Report average temperature maps | -| lfoptions | | | | repETRefMaps | 0 | EVAPO | switch rep maps | input | 0 | | | | Report reference evapo-transpiration | -| lfoptions | | | | repESRefMaps | 0 | EVAPO | switch rep maps | input | 0 | | | | Report reference soil evaporation | -| lfoptions | | | | repEWRefMaps | 0 | EVAPO | switch rep maps | input | 0 | | | | Report reference evaporation of intercepted water | -| lfoptions | | | | repAverageDis | 0 | DISCHARGE | switch rep maps | input | 0 | | | | Report average discharge | -| lfoptions | | | | repChanCrossSectionMaps | 0 | ROUTING | switch rep maps | input | 0 | | | | Report total cross-section area for channels | -| lfoptions | | | | repCumInterCeptionMaps | 0 | INTERCEPTION | switch rep maps | input | 0 | | | | Report cumulative interception | -| lfoptions | | | | repDischargeMaps | 0 | DISCHARGE | switch rep maps | input | 0 | | | | Report maps of average discharge (for each time step) | -| lfoptions | | | | repDSLRMaps | 0 | METEO | switch rep maps | input | 0 | | | | Report maps with number of days since the last rainfall event | -| lfoptions | | | | repESActMaps | 0 | EVAPO | switch rep maps | input | 0 | | | | Report actual soil evaporation | -| lfoptions | | | | repEWIntMaps | 0 | EVAPO | switch rep maps | input | 0 | | | | Report evaporation of intercepted water | -| lfoptions | | | | repFrostIndexMaps | 0 | SNOW | switch rep maps | input | 0 | | | | Report frost index maps | -| lfoptions | | | | repGwLossMaps | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report groundwater loss maps | -| lfoptions | | | | repGwPercUZLZMaps | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report maps of percolation from upper to lower ground water zone (for each time step) | -| lfoptions | | | | repInfiltrationMaps | 0 | INFILTRATION | switch rep maps | input | 0 | | | | Report infiltration maps | -| lfoptions | | | | repInterceptionMaps | 0 | INTERCEPTION | switch rep maps | input | 0 | | | | Report interception maps | -| lfoptions | | | | repLeafDrainageMaps | 0 | LEAF | switch rep maps | input | 0 | | | | Report leaf drainage maps | -| lfoptions | | | | repLZAvInflowMap | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report lower groundwater zone inflow maps | -| lfoptions | | | | repLZMaps | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report maps of lower groundwater zone storage (for each time step) | -| lfoptions | | | | repLZOutflowMaps | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report lower groundwater zone outflow maps | -| lfoptions | | | | repPercolationMaps | 0 | PERCOLATION | switch rep maps | input | 0 | | | | Report percolation maps | -| lfoptions | | | | repPFMaps | 0 | SOIL | switch rep maps | input | 0 | | | | Report pF and vegetation stress due to low soil moisture | -| lfoptions | | | | repPFForestMaps | 0 | SOIL | switch rep maps | input | 0 | | | | Report pF and vegetation stress due to low soil moisture for forest fraction | -| lfoptions | | | | repPrefFlowMaps | 0 | SOIL | switch rep maps | input | 0 | | | | Report preferential flow (rapid bypass soil matrix) | -| lfoptions | | | | repRainMaps | 0 | METEO | switch rep maps | input | 0 | | | | Report rain excluding snow | -| lfoptions | | | | repSeepSubToGWMaps | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report flux between sub soil and GW | -| lfoptions | | | | repSnowCoverMaps | 0 | SNOW | switch rep maps | input | 0 | | | | Report maps of snow cover (for each time step) | -| lfoptions | | | | repSnowMaps | 0 | SNOW | switch rep maps | input | 0 | | | | Report maps of snow (for each time step) | -| lfoptions | | | | repSnowMeltMaps | 0 | SNOW | switch rep maps | input | 0 | | | | Report maps of snowmelt (for each time step) | -| lfoptions | | | | repSurfaceRunoffMaps | 0 | SURFACE | switch rep maps | input | 0 | | | | Report maps of surface runoff (for each time step) | -| lfoptions | | | | repTaMaps | 0 | TRANSPIRATION | switch rep maps | input | 0 | | | | Report transpiration maps | -| lfoptions | | | | repThetaMaps | 0 | SOIL | switch rep maps | input | 0 | | | | Reporting of *individual* model state variables as maps THETA | -| lfoptions | | | | repThetaForestMaps | 0 | SOIL | switch rep maps | input | 0 | | | | Reporting of *individual* model state variables as maps THETA FOREST | -| lfoptions | | | | repThetaIrrigationMaps | 0 | SOIL | switch rep maps | input | 0 | | | | Report irrigation mapsrE | -| lfoptions | | | | repTotalRunoffMaps | 0 | SOIL | switch rep maps | input | 0 | | | | Report total runoff | -| lfoptions | | | | repUZMaps | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report maps of upper groundwater zone storage (for each time step) | -| lfoptions | | | | repUZOutflowMaps | 0 | GROUNDWATER | switch rep maps | input | 0 | | | | Report maps for upper groundwater zone outflow | -| lfoptions | | | | repWaterDepthMaps | 0 | ROUTING | switch rep maps | input | 0 | | | | Report water depth on soil surface | -| lfoptions | | | | repWaterLevelMaps | 0 | ROUTING | switch rep maps | input | 0 | | | | Report water level in channels | -| lfoptions | | | | ETActMaps | 0 | EVAPO | switch rep maps | input | 0 | | | | Report actual evapo-transpiration | -| lfoptions | | | | repFastRunoffMaps | 0 | ROUTING | switch rep maps | input | 0 | | | | Report fast runoff = surface + UZ | -| lfoptions | | | | repRWS | 0 | WATER STRESS | switch rep maps | input | 0 | | | | Report soil transpiration reduction factor RWP | -| lfoptions | | | | repStressDays | 0 | WATER STRESS | switch rep maps | input | 0 | | | | Report soil transpiration reduction factor RWP for forest | -| lfoptions | | | | repPF1Maps | 0 | SOIL | switch rep maps | input | 0 | | | | Report PF1 maps | -| lfoptions | | | | repPF2Maps | 0 | SOIL | switch rep maps | input | 0 | | | | Report PF2 maps | -| lfoptions | | | | repTotalAbs | 0 | WATER ABSTRACTION | switch rep maps | input | 0 | | | | Report total water abstraction | -| lfoptions | | | | repTotalWUse | 0 | WATER ABSTRACTION | switch rep maps | input | 0 | | | | Report total water use | -| lfoptions | | | | repWIndex | 0 | INDICATOR | switch rep maps | input | 0 | | | | Report indexes and indicators | +##**Table:** *LISFLOOD Settings: lfuser.* -**Table:** *Timeseries from LISFLOOD options.* -| key | outputVar | where | repoption | restrictoption | operation | Description | -|----------------------|------------------------------------------------------------------------------------------|----------------|------------------------|-----------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------| -| DisTS | ChanQAvg | Gauges | repDischargeTs | | | Reported average discharge at gauges [m3/s] | -| ChanqTS | ChanQ | Gauges | repDischargeTs | | | Reported instantaneous discharge at gauges [m3/s] | -| WaterLevelTS | WaterLevel | Gauges | repWaterLevelTs | nonInit,simulateWaterLevels | | Reported water level [m] | -| StepsSoilTS | NoSubSteps | 1 | repInternalCom | | mapmaximum | Number of sub-steps needed for soil moisture routine | -| StepsWaterUseTS | NoWaterUseExe | 1 | repInternalCom | nonInit,wateruse | | number of loops needed for water use routine | -| WaterMassBalanceTSS | MBError | Catchments | repMBTs | nonInit | | Reported mass balance error at outlet [cu m] | -| MassBalanceMMTSS | MBErrorMM | Catchments | repMBTs | nonInit | | Reported mass balance error at outlet (as mm water slice) | -| WaterDepthTS | WaterDepth | Sites | repStateSites | nonInit | | Water depth on soil surface [mm] | -| SnowCoverTS | SnowCover | Sites | repStateSites | nonInit | | Depth of snow cover on soil surface [mm] | -| LZTS | LZ | Sites | repStateSites | nonInit | | Storage in lower groundwater zone [mm] | -| DSLRTS | DSLR[0] | Sites | repStateSites | nonInit | | Days since last rain [days] | -| FrostIndexTS | FrostIndex | Sites | repStateSites | nonInit | | Frost index [degree-days] | -| RainTS | Rain | Sites | repRateSites | nonInit | | Rain (excluding snow) [mm/∆t] | -| SnowTS | Snow | Sites | repRateSites | nonInit | | Snow (excluding rain) [mm/∆t] | -| SnowmeltTS | SnowMelt | Sites | repRateSites | nonInit | | Reported snowmelt [mm/∆t] | -| EWIntTS | TaInterceptionAll | Sites | repRateSites | nonInit | | Reported evaporation from interception storage [mm/∆t] | -| TaTS | TaPixel | Sites | repRateSites | nonInit | | Reported transpiration [mm/∆t] | -| ESActTS | ESActPixel | Sites | repRateSites | nonInit | | Reported soil evaporation [mm/∆t] | -| InfiltrationTS | InfiltrationPixel | Sites | repRateSites | nonInit | | Reported infiltration [mm/∆t] | -| PrefFlowTS | PrefFlowPixel | Sites | repRateSites | nonInit | | Reported preferential flow [mm/∆t] | -| PercolationTS | SeepTopToSubPixelB | Sites | repRateSites | nonInit | | Reported percolation from 1st to 2nd soil layer [mm/∆t] | -| SeepSubToGWTS | SeepSubToGWPixel | Sites | repRateSites | nonInit | | Reported seepage to groundwateR [mm/∆t] | -| SurfaceRunoffTS | SurfaceRunoff | Sites | repRateSites | nonInit | | Reported surface runoff [mm/∆t] | -| TotalRunoffTS | TotalRunoff | Sites | repRateSites | nonInit | | Reported total runoff [mm/∆t] | -| UZOutflowTS | UZOutflowPixel | Sites | repRateSites | nonInit | | Reported upper groundwater zone outflow [mm/∆t] | -| LZOutflowTS | LZOutflowToChannelPixel | Sites | repRateSites | nonInit | | Reported lower zone outflow [mm/∆t] | -| GwPercUZLZTS | GwPercUZLZPixel | Sites | repRateSites | nonInit | | Reported percolation from upper to lower zone [mm/∆t] | -| GwLossTS | GwLossPixel | Sites | repRateSites | nonInit | | Reported loss from lower zone [mm/∆t] | -| PrecipitationAvUpsTS | Precipitation | Gauges | repMeteoUpsGauges | nonInit | total | Precipitation [mm/time step] | -| TavgAvUpsTS | Tavg | Gauges | repMeteoUpsGauges | nonInit | total | Average temperature upstream of gauges [deg C] | -| ETRefAvUpsTS | ETRef | Gauges | repMeteoUpsGauges | nonInit | total | Reference evapotranspiration [mm/time step] | -| EWRefAvUpsTS | EWRef | Gauges | repMeteoUpsGauges | nonInit | total | Potential open water evaporation [mm/time step] | -| WaterDepthAvUpsTS | WaterDepth | Gauges | repStateUpsGauges | nonInit | total | Water depth on soil surface [mm] | -| SnowCoverAvUpsTS | SnowCover | Gauges | repStateUpsGauges | | total | Depth of snow cover on soil surface [mm] | -| LZAvUpsTS | LZ | Gauges | repStateUpsGauges | nonInit | total | Storage in lower groundwater zone [mm] | -| DSLRAvUpsTS | DSLR[0] | Gauges | repStateUpsGauges | nonInit | total | Days since last rain [days] | -| FrostIndexAvUpsTS | FrostIndex | Gauges | repStateUpsGauges | nonInit | total | Frost index [degree-days] | -| RainAvUpsTS | Rain | Gauges | repRateUpsGauges | nonInit | total | Rain (excluding snow) [mm/∆t] | -| SnowAvUpsTS | Snow | Gauges | repRateUpsGauges | nonInit | total | Snow (excluding rain) [mm/∆t] | -| SnowmeltAvUpsTS | SnowMelt | Gauges | repRateUpsGauges | nonInit | total | Snow melt [mm/∆t] | -| EWIntAvUpsTS | TaInterceptionAll | Gauges | repRateUpsGauges | nonInit | total | Evaporation from interception storage [mm/∆t] | -| TaAvUpsTS | TaPixel | Gauges | repRateUpsGauges | nonInit | total | Actual transpiration [mm/∆t] | -| ESActAvUpsTS | ESActPixel | Gauges | repRateUpsGauges | nonInit | total | Actual evaporation [mm/∆t] | -| InfiltrationAvUpsTS | InfiltrationPixel | Gauges | repRateUpsGauges | nonInit | total | Infiltration [mm/∆t] | -| PrefFlowAvUpsTS | PrefFlowPixel | Gauges | repRateUpsGauges | nonInit | total | Preferential flow [mm/∆t] | -| PercolationAvUpsTS | SeepTopToSubPixelB | Gauges | repRateUpsGauges | nonInit | total | Percolation flow [mm/∆t] | -| SeepSubToGWAvUpsTS | SeepSubToGWPixel | Gauges | repRateUpsGauges | nonInit | total | Seepage from lower soil layer to groundwater [mm/∆t] | -| SurfaceRunoffAvUpsTS | SurfaceRunoff | Gauges | repRateUpsGauges | | total | Surface runoff [mm/∆t] | -| TotalRunoffAvUpsTS | TotalRunoff | Gauges | repRateUpsGauges | | total | Total runoff [mm/∆t] | -| UZOutflowAvUpsTS | UZOutflowPixel | Gauges | repRateUpsGauges | nonInit | total | Outflow from upper zone (to channel) [mm/∆t] | -| LZOutflowAvUpsTS | LZOutflowToChannelPixel | Gauges | repRateUpsGauges | nonInit | total | Outflow from lower zone (to channel) [mm/∆t] | -| GwPercUZLZAvUpsTS | GwPercUZLZPixel | Gauges | repRateUpsGauges | nonInit | total | Reported percolation from upper to lower zone [mm/∆t] | -| GwLossAvUpsTS | GwLossPixel | Gauges | repRateUpsGauges | nonInit | total | Reported loss from lower zone [mm/∆t] | -| LakeInflowTS | LakeInflowM3S | LakeSites | repsimulateLakes | nonInit,simulateLakes | | Output timeseries file with lake inflow [cu m /s] | -| LakeOutflowTS | LakeOutflowM3S | LakeSites | repsimulateLakes | nonInit,simulateLakes | | Output timeseries file with lake outflow [cu m /s] | -| LakeLevelTS | LakeLevel | LakeSites | repsimulateLakes | nonInit,simulateLakes | | Output timeseries file with lake level [m] | -| ReservoirFillTS | ReservoirFill | ReservoirSites | repsimulateReservoirs | nonInit,simulateReservoirs | | name of output TSS file with Reservoir Filling | -| ReservoirInflowTS | ReservoirInflowM3S | ReservoirSites | repsimulateReservoirs | nonInit,simulateReservoirs | | name of output TSS file with Reservoir Inflow | -| ReservoirOutflowTS | ReservoirOutflowM3S | ReservoirSites | repsimulateReservoirs | nonInit,simulateReservoirs | | name of output TSS file with Reservoir Outflow | -| PolderLevelTS | PolderLevel | PolderSites | repsimulatePolders | nonInit,simulatePolders | | name of output TSS file with polder level [m] | -| PolderFluxTS | PolderFlux | PolderSites | repsimulatePolders | nonInit,simulatePolders | | name of output TSS file with polder flux [cu m / s]. Positive for flow from channel to polder, negative for polder to channel | -| WaterUseTS | WUseSumM3 | Gauges | repwateruseGauges | nonInit,wateruse | | Time series of upstream water use at gauging stations | -| WaterUseSitesTS | WUseSumM3 | Sites | repwateruseSites | nonInit,wateruse | | Time series of upstream water use at sites | -| PF1TS | pF1[0] | Sites | repPFSites | nonInit,simulatePF | | Reported pF upper soil layer [-] | -| PF1ForestTS | pF1[1] | Sites | repPFSites | nonInit,simulatePF | | Reported pF upper soil layer for forest [-] | -| PF2TS | pF2[0] | Sites | repPFSites | nonInit,simulatePF | | Reported pF lower soil layer [-] | -| PF2ForestTS | pF2[1] | Sites | repPFSites | nonInit,simulatePF | | Reported pF lower soil layer for forest [-] | -| PF1AvUpsTS | pF1[0] | Gauges | repPFUpsGauges | nonInit,simulatePF | total | Reported average value of pF upstream of gauges for upper soil layer [-] | -| PF1ForestAvUpsTS | pF1[1] | Gauges | repPFUpsGauges | nonInit,simulatePF | total | Reported average value of pF upstream of gauges for upper soil layer for forest [-] | -| PF2AvUpsTS | pF2[0] | Gauges | repPFUpsGauges | nonInit,simulatePF | total | Reported average value of pF upstream of gauges for lower soil layer [-] | -| PF2ForestAvUpsTS | pF2[1] | Gauges | repPFUpsGauges | nonInit,simulatePF | total | Reported average value of pF upstream of gauges for lower soil layer for forest [-] | -| LZAvInflowTS | LZAvInflow | Sites | repLZAvInflowSites | | | Time series of average percolation rate from upper to lower groundwater zone (reported at sites) | -| LZAvInflowAvUps | LZAvInflow | Gauges | repLZAvInflowUpsGauges | total | LZAvInflowAvUps | | -| PrecipitationAvUpsTS | Precipitation | Gauges | repBal1 | | total | Precipitation [mm/time step] | -| TotalRunoffAvUpsTS | TotalRunoff | Gauges | repBal1 | | total | Total runoff [mm/∆t] | -| GwLossAvUpsTS | GwLossPixel | Gauges | repBal1 | | total | Reported loss from lower zone [mm/∆t] | -| TaAvUpsTS | TaPixel | Gauges | repBal1 | nonInit | total | Actual transpiration [mm/∆t] | -| ESActAvUpsTS | ESActPixel | Gauges | repBal1 | nonInit | total | Actual evaporation [mm/∆t] | -| EWIntAvUpsTS | TaInterceptionAll | Gauges | repBal1 | nonInit | total | Evaporation from interception storage [mm/∆t] | -| EvaOpenWaterAvUpsTS | EvaAddM3*self.var.M3toMM | Gauges | repBal1 | nonInit | total | EvaOpenWaterAvUpsTS | -| actETPUpsTS | ESActPixel+self.var.TaPixel+self.var.TaInterceptionAll+self.var.EvaAddM3*self.var.M3toMM | Gauges | repBal1 | nonInit | total | actETPUpsTS | -| RunLossUpsTS | TotalRunoff+self.var.GwLossPixel | Gauges | repBal1 | nonInit | total | RunLossUpsTS | -| actETPUpsTS | ESActPixel+self.var.TaPixel+self.var.TaInterceptionAll+self.var.EvaAddM3*self.var.M3toMM | Gauges | repBal1 | nonInit | total | actETPUpsTS | -| RunLossUpsTS | TotalRunoff+self.var.GwLossPixel | Gauges | repBal1 | nonInit | total | RunLossUpsTS | +| section (XML) | module | KEY | Type | I/O | Description | +|:------------------------|:-------------------------------------------|:-------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| --------------- | ------------------------------------ | --------------------------------- | --------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| lfuser | SETTINGS | PathRoot | path | input | Root directory | +| lfuser | SETTINGS | MaskMap | map | input | Computation area for Lisflood model | +| lfuser | SETTINGS | Gauges | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) or lat lon (lat2 lon2 ...) | +| lfuser | SETTINGS | netCDFtemplate | map | input | netcdf template used to copy metadata information for writing netcdf $(PathEvapo)/$(PrefixE0) | +| lfuser | SETTINGS | CalendarDayStart | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | +| lfuser | SETTINGS | DtSec | value | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | +| lfuser | SETTINGS | DtSecChannel | value | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | +| lfuser | SETTINGS | StepStart | value/date | input | Step id number or date of the simulation start step. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | +| lfuser | SETTINGS | StepEnd | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | +| lfuser | SETTINGS | ReportSteps | value | input | Time steps at which to write model state maps. Use: #,#,# to specify single step numbers ; #..# to print all state files between one step and another one "endtime" to print state files for final step (to state file in NetCDF file format stack) | +| lfuser | SETTINGS | NumDaysSpinUp | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | +| lfuser | SETTINGS | NetCDFTimeChunks | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | +| lfuser | SETTINGS | MapsCaching | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | +| lfuser | SETTINGS | OutputMapsChunks | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | +| lfuser | SETTINGS | OutputMapsDataType | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | +| lfuser | GROUNDWATER | UpperZoneTimeConstant | value/map | input calib par | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | +| lfuser | GROUNDWATER | LowerZoneTimeConstant | value/map | input calib par | Time constant for the lower groundwater zone [days] This is the average time a water 'particle' remains in the reservoir if we had a stationary system (average inflow=average outflow) default: 100 | +| lfuser | GROUNDWATER | GwPercValue | value/map | input calib par | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | +| lfuser | GROUNDWATER | GwLoss | value/map | input calib par | Rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. A value of 0 (closed lower boundary) is recommended as a starting value; default: 0.0 | +| lfuser | GROUNDWATER | LZThreshold | value/map | input calib par | threshold value below which there is no outflow to the channel | +| lfuser | INFILTRATION | b_Xinanjiang | value/map | input calib par | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | +| lfuser | INFILTRATION | PowerPrefFlow | value/map | input calib par | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | +| lfuser | KINEMATIC WAVE | CalChanMan | value/map | input calib par | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | +| lfuser | SNOW | SnowMeltCoef | value/map | input calib par | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | +| lfuser | DOUBLE KINEMATIC WAVE | CalChanMan2 | value/map | input calib par | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | +| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | +| lfuser | MCT DIFFUSIVE WAVE | CalChanMan3 | value/map | input calib par | Multiplier [-] applied to Channel Manning's n for MCT diffusive wave routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | +| lfuser | LAKES | LakeMultiplier | value/map | input calib par | Multiplier applied to the lake parameter A | +| lfuser | RESERVOIRS | ReservoirFloodStorage | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | +| lfuser | RESERVOIRS | ReservoirFloodOutflowFactor | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | +| lfuser | TRANSMISSION LOSSES | TransSub | value/map | input calib par | Transmission loss function parameter | +| lfuser | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | +| lfuser | SETTINGS | AvWaterRateThreshold | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] . Default: 5.0 (not included in calibration) | +| lfuser | SETTINGS | PathOut | path | input | Directory where all output files are written. It must be an existing directory (if not you will get an error message). | +| lfuser | SETTINGS | PathInit | path | input | Path of the initial value maps e.g. lzavin.map (org=$(PathRoot)/outPo) It is the directory where the initial files are located, to initialize a “warm” start. It can be also the PathOut directory. | +| lfuser | SETTINGS | PathMaps | path | input | Maps path it is the directory where all input base maps are located | +| lfuser | INFLOW | PathInflow | path | input | Inflow path | +| lfuser | SETTINGS | PathParams | path | input | Calibration parameter path | +| lfuser | TABLE | PathTables | path | input | Tables path | +| lfuser | TABLE | PathMapsTables | path | input | Legacy terminology: path to folder where input maps are stored (some of these input maps used to be tables in legacy versions of the code) | +| lfuser | SOIL | PathSoilHyd | path | input | Maps instead tables for soil hydraulics path Directory where the soil hydraulic property maps are located | +| lfuser | LANDUSE | PathMapsLandUseChange | path | input | Maps for transient land use changes every 5 years | +| lfuser | LANDUSE | PathMapsLanduse | path | input | Maps for land use fractions and related land use maps | +| lfuser | WATER USE | PathWaterUse | path | input | Water use maps path | +| lfuser | METEO | PathMeteo | path | input | Meteo path Directory where all maps with meteorological input are located (rain, evapo(transpi)ration, temperature) | +| lfuser | LAI | PathLAI | path | input | Leaf Area Index maps path Directory where you Leaf Area Index maps are located | +| lfuser | SETTINGS | timestepInit | value/date | input initial | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". It is generally one step back compared to StepStart). timestepInit is ignored if netCDF file is a single netCDF file.. | +| lfuser | SURFACE | OFDirectInitValue | value/map | input initial/internal | Initial water volume for direct fraction on catchment surface [m3] | +| lfuser | SURFACE | OFOtherInitValue | value/map | input initial/internal | Initial water volume for other fraction on catchment surface [m3] | +| lfuser | SURFACE | OFForestInitValue | value/map | input initial/internal | Initial water volume for forest fraction on catchment surface [m3] | +| lfuser | SNOW | SnowCoverAInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone A [mm] | +| lfuser | SNOW | SnowCoverBInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone B [mm] | +| lfuser | SNOW | SnowCoverCInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone C [mm] | +| lfuser | SNOW | FrostIndexInitValue | value/map | input initial/internal | initial Frost Index value [C day-1] | +| lfuser | INTERCEPTION | CumIntInitValue | value/map | input initial/internal | cumulative interception [mm] Initial interception storage | +| lfuser | GROUNDWATER | UZInitValue | value/map | input initial/internal | It is the initial storage in the upper groundwater zone [mm] , other fraction | +| lfuser | SOIL | DSLRInitValue | value/map | input initial/internal | initial number of days since the last rainfall event [days], , other fraction | +| lfuser | GROUNDWATER | LZInitValue | value/map | input initial/internal | It is the initial storage in the lower groundwater zone [mm] -9999: use steady-state storage | +| lfuser | KINEMATIC WAVE | TotalCrossSectionAreaInitValue | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull It is the initial cross-sectional area [m2] of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). | +| lfuser | SOIL | ThetaInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the supercificial soil layer. Other fraction. | +| lfuser | SOIL | ThetaInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the upper soil layer. Other fraction. | +| lfuser | SOIL | ThetaInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the lower soil layer. Other fraction. | +| lfuser | DOUBLE KINEMATIC WAVE | CrossSection2AreaInitValue | value/map | input initial/internal | initial channel cross-sectional area [m2] of the water in the river channels for 2nd routing channel -9999: use 0 | +| lfuser | DOUBLE KINEMATIC WAVE | PrevSideflowInitValue | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| lfuser | MCT DIFFUSIVE WAVE | PrevCmMCTInitValue | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| lfuser | MCT DIFFUSIVE WAVE | PrevDmMCTInitValue | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| lfuser | LAKES | LakeInitialLevelValue | value/map | input initial/internal | Initial lake level [m] -9999 sets initial value to steady-state level | +| lfuser | KINEMATIC WAVE | PrevDischarge | value/map | input initial/internal | initial discharge from previous run only needed for MCT diffusive routing -9999: use 0 It is the initial discharge from previous run [m3s-1] used for MCT diffusive routing. Note that PrevDischarge is the instantaneous discharge referred to the end of the time step. | +| lfuser | KINEMATIC WAVE | PrevDischargeAvg | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only -9999: use 0 It is the initial discharge from previous run [m3s-1] used for lakes, reservoirs and transmission loss Note that PrevDischargeAvg is the average discharge for the last routing sub-step. | +| lfuser | INTERCEPTION | CumIntForestInitValue | value/map | input initial/internal | cumulative interception forest [mm] | +| lfuser | GROUNDWATER | UZForestInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | +| lfuser | SOIL | DSLRForestInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | +| lfuser | SOIL | ThetaForestInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values Forest fraction | +| lfuser | SOIL | ThetaForestInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values Forest fraction | +| lfuser | SOIL | ThetaForestInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values Forest fraction | +| lfuser | INTERCEPTION | CumIntIrrigationInitValue | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| lfuser | GROUNDWATER | UZIrrigationInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | +| lfuser | SOIL | DSLRIrrigationInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | +| lfuser | SOIL | ThetaIrrigationInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 for irrigation -9999: use field capacity values Irrigated fraction | +| lfuser | SOIL | ThetaIrrigationInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values Irrigated fraction | +| lfuser | SOIL | ThetaIrrigationInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 for irrigation -9999: use field capacity values Irrigated fraction | +| lfuser | SOIL | CumIntSealedInitValue | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| lfuser | SOIL | cumSeepTopToSubBOtherEnd | map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | SOIL | cumSeepTopToSubBForestEnd | map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | SOIL | cumSeepTopToSubBIrrigatedEnd | map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | GROUNDWATER | CumQEnd | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfuser | GROUNDWATER | TimeSinceStartPrerunChunkEnd | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | +| lfuser | GROUNDWATER | LZInflowCumEnd | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfuser | METEO | PrefixPrecipitation | prefix | input forcings | prefix precipitation maps | +| lfuser | METEO | PrefixTavg | prefix | input forcings | prefix average temperature maps | +| lfuser | EVAPO | PrefixE0 | prefix | input forcings | prefix E0 (potential open water evaporation) maps | +| lfuser | EVAPO | PrefixES0 | prefix | input forcings | prefix ES0 (potential open bare-soil evaporation)maps | +| lfuser | EVAPO | PrefixET0 | prefix | input forcings | prefix ET0 (potential reference evapotranspioration) maps | +| lfuser | LAI | PrefixLAIOther | prefix | input forcings | prefix LAI (Leaf Area Index) maps | +| lfuser | LAI | PrefixLAIForest | prefix | input forcings | prefix LAI forest maps | +| lfuser | LAI | PrefixLAIIrrigation | prefix | input forcings | prefix LAI irrigation maps | +| lfuser | WATER USE | PrefixWaterUseDomestic | prefix | input forcings | prefix domestic water use maps | +| lfuser | WATER USE | PrefixWaterUseLivestock | prefix | input forcings | prefix livestock water use maps | +| lfuser | WATER USE | PrefixWaterUseEnergy | prefix | input forcings | prefix energy water use maps | +| lfuser | WATER USE | PrefixWaterUseIndustry | prefix | input forcings | prefix industry water use maps | +| lfuser | METEO | PrScaling | value | input par | Multiplier applied to potential precipitation rates. Default = 1.0, not used in calibration. | +| lfuser | EVAPO | CalEvaporation | value | input par | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | +| lfuser | LEAF DRAINAGE | LeafDrainageTimeConstant | value | input par | Time constant for water in interception store [days] . Default = 1.0 | +| lfuser | EVAPO | kdf | value | input par | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | +| lfuser | DEPRESSION STORAGE | SMaxSealed | value | input par | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] . This storage is emptied by evaporation (EW0). Default = 1.0 | +| lfuser | SNOW | SnowFactor | value | input par | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | +| lfuser | SNOW | SnowSeasonAdj | value | input par | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | +| lfuser | SNOW | TempMelt | value | input par | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | +| lfuser | SNOW | TempSnow | value | input par | It is the average temperature below which precipitation is assumed to be snow [°C] | +| lfuser | SNOW | TemperatureLapseRate | value | input par | Temperature lapse rate with altitude [deg C / m]. It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1]. Default = 0.0065 | +| lfuser | SNOW | Afrost | value | input par | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. Default = 0.97 | +| lfuser | SNOW | Kfrost | value | input par | Snow depth reduction coefficient, [cm-1]. Default = 0.57 | +| lfuser | SNOW | SnowWaterEquivalent | value | input par | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | +| lfuser | SNOW | FrostIndexThreshold | value | input par | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | +| lfuser | WATER ABSTRACTION | IrrigationEfficiency | value/map | input | Field application irrigation efficiency max 1, ~0.90 drip irrigation, ~0.75 sprinkling | +| lfuser | WATER ABSTRACTION | ConveyanceEfficiency | value/map | input | onveyance efficiency, around 0.80 for average channel | +| lfuser | WATER ABSTRACTION | IrrigationType | value | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | +| lfuser | WATER ABSTRACTION | IrrigationMult | value | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | +| lfuser | WATER ABSTRACTION | LivestockConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | +| lfuser | WATER ABSTRACTION | IndustryConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | +| lfuser | WATER ABSTRACTION | EnergyConsumptiveUseFraction | value/map | input | Consumptive Use (1-Recycling ratio) for energy water use (0-1) Source: Torcellini et al. (2003) "Consumptive Use for US Power Production" map advised by Neil Edwards, Energy Industry the UK and small French rivers the consumptive use varies between 1:2 and 1:3, so 0.33-0.50 For plants along big rivers like Rhine and Danube the 0.025 is ok EnergyConsumptiveUseFraction=0.025 | +| lfuser | WATER ABSTRACTION | DomesticConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | +| lfuser | WATER ABSTRACTION | LeakageFraction | value | input | $(PathMaps)/leakage.map Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | +| lfuser | WATER ABSTRACTION | LeakageWaterLoss | value | input | The water that is lost from leakage (lost) (0-1) | +| lfuser | WATER ABSTRACTION | LeakageReductionFraction | value | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | +| lfuser | WATER ABSTRACTION | WaterSavingFraction | value | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | +| lfuser | CALC INDICATOR | Population | map | input | Population per pixel | +| lfuser | CALC INDICATOR | PopulationMaps | map | input | Population map for TransientLandUseChange | +| lfuser | CALC INDICATOR | LandUseMask | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | +| lfuser | WATER ABSTRACTION | WaterUseMaps | map | output | path and prefix of the reported water use m3 s-1 as a result of demand and availability | +| lfuser | WATER ABSTRACTION | WaterUseTS | tss | output | Time series of upstream water use at gauging stations | +| lfuser | WATER ABSTRACTION | StepsWaterUseTS | tss | output | number of loops needed for water use routine | +| lfuser | WATER ABSTRACTION | maxNoWateruse | value | input | maximum number of loops for calculating the use of water | +| lfuser | WATER ABSTRACTION | WUsePercRemain | value | input | percentage of water that must remain the channel (after water abstraction) | +| lfuser | WATER ABSTRACTION / CALC INDICATOR | WUseRegion | map | input | area from which surface water is extracted | +| lfuser | GROUNDWATER | LZSmoothRange | value | input | length of the window used to smooth the LZ zone [number of cell length] It works ONLY if wateruse=1 | +| lfuser | GROUNDWATER | GroundwaterBodies | map | input | map of aquifers (0/1), used to smoothen LZ near extraction areas | +| lfuser | LAKES | LakeMask | map | input | Mask with Lakes from GLWD database | +| lfuser | TRANSMISSION | TransPower1 | value | input par | Transmission loss function parameter. Default = 2.0 | +| lfuser | TRANSMISSION | TransArea | value | input par | downstream area taking into account for transmission loss | +| lfuser | TRANSMISSION / RESERVOIR | UpAreaTrans | map | inpput | upstream area for transmission loss and computation of K coeff in reservoirs module | +| lfuser | KINEMATIC WAVE | beta | value | input par | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | +| lfuser | KINEMATIC WAVE | OFDepRef | value | input par | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | +| lfuser | KINEMATIC WAVE | GradMin | value | input par | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | +| lfuser | KINEMATIC WAVE | ChanGradMin | value | input par | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | +| lfuser | MCT DIFFUSIVE WAVE | ChannelsMCT | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | +| lfuser | MCT DIFFUSIVE WAVE | ChanGradMaxMCT | value | input par | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) [m m-1] | +| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value | input par | PBchange Multiplier applied to average Q to split into a second line of routing | +| lfuser | SOIL | CourantCrit | value | input par | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | +| lfuser | RESERVOIRS | DtSecReservoirs | value | input | Sub time step used for reservoir simulation [s]. Within the model, the smallest out of DtSecReservoirs and DtSec is used. | +| lfuser | RESERVOIRS | ReservoirInitialFillValue | value/map | input initial/internal | Initial reservoir fill fraction -9999 sets initial fill to normal storage limit if you're not using the reservoir option, enter some bogus value | +| lfuser | LAKES | TabLakeAvNetInflowEstimate | table | input | Estimate of average net inflow into lake (=inflow - evaporation) [cu m / s] Used to calculated steady-state lake level in case LakeInitialLevelValue is set to -9999 | +| lfuser | INFLOW | InflowPoints | map | input forcings | OPTIONAL: nominal map with locations of (measured) inflow hydrographs [cu m / s] | +| lfuser | INFLOW | QInTS | tss | input forcings | OPTIONAL: observed or simulated input hydrographs as time series [cu m / s] Note that identifiers in time series correspond to InflowPoints map (also optional) | +| lfuser | SOIL | HeadMax | value | input | Maximum capillary head [cm]. This value is used if Theta equals residual soil moisture content (value of HeadMax is arbitrary). Only needed for pF computation, otherwise doesn't influence model results at all) | +| lfuser | EVAPORATION FROM OPEN WATER | maxNoEva | 10 | value | input | +##**Table:** *LISFLOOD Settings: lfbinding.* -**Table:** *Maps from LISFLOOD options.* +| section (XML) | module | KEY | settings | Type | I/O | Description | +|:------------------------|:---------------------------------------------------------------|:-------------------------------------------|:------------------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :-------------------- | :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| --------------- | ------------------------------------ | --------------------------------- | --------------- | --------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| lfbinding | SNOW AND FROST | Afrost | $(Afrost) | value | input | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | +| lfbinding | INITIAL CONDITION | AvgDis | $(PathInit)/avgdis.map | map | input initial/internal | $(PathInit)/avgdis.map CHANNEL split routing in two lines Average discharge map [m3/s] | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | AvWaterRateThreshold | $(AvWaterRateThreshold) | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | +| lfbinding | INFILTRATION | b_Xinanjiang | $(b_Xinanjiang) | map | input | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | +| lfbinding | ROUTING | beta | $(beta) | 0 | input | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | +| lfbinding | ROUTING | CalChanMan | $(CalChanMan) | 0 | input | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | +| lfbinding | ROUTING | CalChanMan2 | $(CalChanMan2) | value/map | input | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | +| lfbinding | ROUTING | CalChanMan3 | $(CalChanMan3) | value/map | input | Multiplier [-] applied to Channel Manning's n for MCT routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | +| lfbinding | TIMESTEP RELATED PARAMETERS | CalendarDayStart | $(CalendarDayStart) | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | CalEvaporation | $(CalEvaporation) | value | input | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChanCrossSectionEnd | $(PathOut)/chcro.end | map | output/end | Reported chan cross-section area [m2] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanCrossSectionState | $(PathOut)/chcro | map | output/state | Reported chan cross-section area [m2] | +| lbinding | ROUTING | ChanGradMaxMCT | $(ChanGradMaxMCT) | map | input | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) | +| lfbinding | ROUTING | ChanGradMin | $(ChanGradMin) | nan | input | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | +| lbinding | ROUTING | ChannelsMCT | $(ChannelsMCT) | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQAvgDtEnd | $(PathOut)/chanqavgdt.end | map | output/end | Reported average discharge on the last routing sub-step [cu m/s] ChanQAvgDt | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQAvgDtState | $(PathOut)/chanqavgdt | map | output/state | Reported average discharge the last routing sub-step [cu m/s] ChanQAvgDt | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQEnd | $(PathOut)/chanq.end | map | output/end | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQState | $(PathOut)/chanq | map | output/state | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChSideEnd | $(PathOut)/chside.end | map | output/end | Reported channel side flow | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChSideState | $(PathOut)/chside | map | output/state | Reported sideflow to channel for first line of routing [m3/s] | +| lfbinding | WATER USE MAPS AND PAR | ConveyanceEfficiency | $(ConveyanceEfficiency) | map | input | onveyance efficiency, around 0.80 for average channel | +| lfbinding | NUMERICS | CourantCrit | $(CourantCrit) | value | input | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | +| lfbinding | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | input initial/internal | initial channel crosssection for 2nd routing channel -9999: use 0 | +| lfbinding | REPORTED OUTPUT MAPS (END) | CrossSection2End | $(PathOut)/ch2cr.end | map | output/end | Cross section area for split routing [m2] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CrossSection2State | $(PathOut)/ch2cr | map | output/state | Cross section area for split routing [m2] | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionEnd | $(PathOut)/cum.end | map | output/end | Reported interception storage | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionForestEnd | $(PathOut)/cumf.end | map | output/end | Reported interception storage for forest | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionForestState | $(PathOut)/cumf | map | output/state | Reported interception storage for forest | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionIrrigationEnd | $(PathOut)/cumi.end | map | output/end | Reported interception storage for irrigation | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionIrrigationState | $(PathOut)/cumi | map | output/state | Reported interception storage | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionState | $(PathOut)/cum | map | output/state | Reported interception storage | +| lfbinding | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | input initial/internal | cumulative interception forest [mm] | +| lfbinding | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | input initial/internal | cumulative interception [mm] | +| lfbinding | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumIntSealedEnd | $(PathOut)/cseal.end | map | output/end | Reported depression storage | +| lfbinding | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumIntSealedState | $(PathOut)/cseal | map | output/state | Reported depression storage | +| lfbinding | REPORTED OUTPUT MAPS (END) | DischargeEnd | $(PathOut)/dis.end | map | output/end | Reported average discharge on the model timestep [m3/s] | +| lfbinding | REPORTED OUTPUT MAPS | DischargeMaps | $(PathOut)/dis | map | output | Reported average discharge [cu m/s] (average over model timestep) | +| lfbinding | REPORTED OUTPUT MAPS | DisMaps | $(PathOut)/q | map (missing) | output | Reported discharge [cu m/s] at the end of a timestep | +| lfbinding | WATER USE MAPS AND PARAMETERS | DomesticConsumptiveUseFraction | $(DomesticConsumptiveUseFraction) | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | +| lfbinding | INPUT WATER USE MAPS AND PAR | DomesticDemandMaps | $(PathWaterUse)/$(PrefixWaterUseDomestic) | map | input | Domestic water abstraction daily maps [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | DSLREnd | $(PathOut)/dslr.end | map | output/end | Reported days since last rain | +| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRForestEnd | $(PathOut)/dslf.end | map | output/end | Reported days since last rain for forest | +| lfbinding | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRForestState | $(PathOut)/dslf | map | output/state | Reported days since last rain for forest | +| lfbinding | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | input initial/internal | days since last rainfall | +| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRIrrigationEnd | $(PathOut)/dsli.end | map | output/end | Reported days since last rain for irrigation | +| lfbinding | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRIrrigationState | $(PathOut)/dsli | map | output/state | Reported days since last rain irrigation | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | DSLRMaps | $(PathOut)/dslr | map | output | Reported days since last rain | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRState | $(PathOut)/dslr | map | output/state | Reported days since last rain [ndays] | +| lfbinding | TIMESTEP RELATED PARAMETERS | DtSec | $(DtSec) | map | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | +| lfbinding | TIMESTEP RELATED PARAMETERS | DtSecChannel | $(DtSecChannel) | map | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | +| lfbinding | INPUT METEO AND VEG MAPS | E0Maps | $(PathMeteo)/$(PrefixE0) | map | input | daily reference evaporation (free water) [mm/day] | +| lfbinding | WATER USE MAPS AND PARAMETERS | EnergyConsumptiveUseFraction | $(EnergyConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for energy production water use (0-1) | +| lfbinding | INPUT WATER USE MAPS AND PAR | EnergyDemandMaps | $(PathWaterUse)/$(PrefixWaterUseEnergy) | map | input | Energy water abstraction daily maps [mm] | +| lfbinding | INPUT METEO AND VEG MAPS | ES0Maps | $(PathMeteo)/$(PrefixES0) | map | input | daily reference evaporation (soil) [mm/day] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ESRefMapsOut | $(PathOut)/es | map | output | Potential evaporation from bare soil surface [mm per time step] | +| lfbinding | INPUT METEO AND VEG MAPS | ET0Maps | $(PathMeteo)/$(PrefixET0) | map | input | daily reference evapotranspiration (crop) [mm/day] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ETRefMapsOut | $(PathOut)/et | map | output | Potential reference evapotranspiration [mm per time step] | +| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenMaps | $(PathOut)/evaop | map (missing) | output | Reported evaporation from open water [mm] | +| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenTS | $(PathOut)/evaopenUps.tss | tss (missing) | output | Time series of upstream water evaporation from open water at gauging stations | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EWRefMapsOut | $(PathOut)/ew | map | output | Potential evaporation from open water surface [mm per time step] | +| lfbinding | EVAPORATION FROM OPEN WATER | FracMaxWater | $(FracMaxWater) | value | input | Percentage of maximum extend of water | +| lfbinding | REPORTED OUTPUT MAPS (END) | FrostIndexEnd | $(PathOut)/frost.end | map | output/end | Reported frost index | +| lfbinding | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | input initial/internal | initial frost index value | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | FrostIndexState | $(PathOut)/frost | map | output/state | Reported frost index | +| lfbinding | SNOW AND FROST | FrostIndexThreshold | $(FrostIndexThreshold) | map | input | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | +| lfbinding | ROUTING | GradMin | $(GradMin) | 0 | input | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | +| lfbinding | GROUNDWATER RELATED PAR | GwLoss | $(GwLoss) | map | input | Maximum loss rate out of Lower response box, expressed as a fraction of lower zone outflow. Fraction [-], range 0-1 A value of 0 (closed lower boundary) is recommended as a starting value Maximum rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. default: 0.0 | +| lfbinding | GROUNDWATER RELATED PAR | GwPercValue | $(GwPercValue) | map | input | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | +| lfbinding | INPUT WATER USE MAPS AND PAR | IndustrialDemandMaps | $(PathWaterUse)/$(PrefixWaterUseIndustry) | map | input | Industry water abstraction daily maps [mm] | +| lfbinding | WATER USE MAPS AND PARAMETERS | IndustryConsumptiveUseFraction | $(IndustryConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | +| lfbinding | WATER USE MAPS AND PAR | IrrigationEfficiency | $(IrrigationEfficiency) | map | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | +| lfbinding | WATER USE MAPS AND PAR | IrrigationMult | $(IrrigationMult) | map | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | +| lfbinding | WATER USE MAPS AND PAR | IrrigationType | $(IrrigationType) | map | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | kdf | $(kdf) | value | input | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | +| lfbinding | SNOW AND FROST | Kfrost | $(Kfrost) | map | input | Snow depth reduction coefficient, [cm-1] | +| lfbinding | INPUT METEO AND VEG MAPS | LAIForestMaps | $(PathLAI)/$(PrefixLAIForest) | map | input | leaf area index forest [m2/m2] | +| lfbinding | INPUT METEO AND VEG MAPS | LAIIrrigationMaps | $(PathLAI)/$(PrefixLAIIrrigation) | map | input | leaf area index irrigation [m2/m2] | +| lfbinding | INPUT METEO AND VEG MAPS | LAIOtherMaps | $(PathLAI)/$(PrefixLAIOther) | map | input | leaf area index [m2/m2] | +| lfbinding | REPORTED OUTPUT MAPS (END) | LakeLevelEnd | $(PathOut)/lakeh.end | map | output/end | Reported lake level | +| lfbinding | EVAPORATION FROM OPEN WATER | LakeMask | $(LakeMask) | map | input | Mask with Lakes from GLWD database | +| lfbinding | REPORTED OUTPUT MAPS (END) | LakeStorageM3 | $(PathOut)/lakest | map | output | Reported lake storage | +| lfbinding | WATER USE MAPS AND PAR | LandUseMask | $(LandUseMask) | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | LeafDrainageTimeConstant | $(LeafDrainageTimeConstant) | map | input | Time constant for leaf drainage | +| lfbinding | WATER USE MAPS AND PARAMETERS | LeakageFraction | $(LeakageFraction) | map | input | Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | +| lfbinding | WATER USE MAPS AND PAR | LeakageReductionFraction | $(LeakageReductionFraction) | map | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | +| lfbinding | WATER USE MAPS AND PAR | LeakageWaterLoss | $(LeakageWaterLoss) | 0 | input | The water that is lost from leakage (lost) (0-1) | +| lfbinding | IRRIGATION AND WATER ABSTRACTION | LivestockConsumptiveUseFraction | $(LivestockConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | +| lfbinding | INPUT WATER USE MAPS AND PAR | LivestockDemandMaps | $(PathWaterUse)/$(PrefixWaterUseLivestock) | map | input | Livestock water abstraction daily maps [mm] | +| lfbinding | GROUNDWATER RELATED PAR | LowerZoneTimeConstant | $(LowerZoneTimeConstant) | map | input | Time constant for the lower groundwater zone [days] | +| lfbinding | INITIAL CONDITION | LZAvInflowMap | $(PathInit)/lzavin.map | value/map | input initial/internal | $(PathInit)/lzavin.map Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | +| lfbinding | REPORTED OUTPUT MAPS (END) | LZEnd | $(PathOut)/lz.end | map | output/end | Reported storage in lower groundwater zone response box [mm] | +| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | input initial/internal | water in lower store [mm] -9999: use steady-state storage | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | LZMaps | $(PathOut)/lz | map | output | Reported storage in lower groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | LZState | $(PathOut)/lz | map | output/state | Reported storage in lower response box [mm] | +| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropCoef | $(PathMapsTables)/cropcoef_i.map | table | input | Irrigation crop coefficient | +| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropGroupNumber | $(PathMapsTables)/cropgrpn_i.map | table | input | Irrigation crop group number | +| lfbinding | REPORTED OUTPUT MAPS | MaskDischargeMaps | $(PathOut)/dism | map (missing) | output | Reported discharge [cu m/s] but cut by a discharge mask map | +| lfbinding | SETTINGS | MaskMap | $(MaskMap) | map/value | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | +| lfbinding | EVAPORATION FROM OPEN WATER | maxNoEva | $(maxNoEva) | value | input | Maximum number of loops for calculating evaporation (distance water is taken to satisfy the need of evaporation from open water). Default = 10 | +| lfbinding | WATER USE MAPS AND PAR | maxNoWateruse | $(maxNoWateruse) | value | input | maximum number of loops for calculating the use of water (=distance to the water demand cell) | +| lfbinding | SETTINGS | netCDFtemplate | $(netCDFtemplate) | map | input | netcdf template used to copy metadata information for writing netcdf | +| lfbinding | ROUTING | OFDepRef | $(OFDepRef) | 0 | input | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | +| lfbinding | REPORTED OUTPUT MAPS (END) | OFDirectEnd | $(PathOut)/ofdir.end | map | output/end | Reported water volume for direct fraction on catchment surface | +| lfbinding | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | input initial/internal | Reported water volume for direct fraction on catchment surface [m^3] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFDirectState | $(PathOut)/ofdir | map | output/state | Reported water volume for direct fraction on catchment surface [m3] | +| lfbinding | REPORTED OUTPUT MAPS (END) | OFForestEnd | $(PathOut)/offor.end | map | output/end | | +| lfbinding | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | input initial/internal | Reported water volume for other fraction on catchment surface [m^3] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFForestState | $(PathOut)/offor | map | output/state | Reported water volume for forest fraction on catchment surface [m3] | +| lfbinding | REPORTED OUTPUT MAPS (END) | OFOtherEnd | $(PathOut)/ofoth.end | map | output/end | | +| lfbinding | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | input initial/internal | Reported water volume for forest fraction on catchment surface [m^3] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFOtherState | $(PathOut)/ofoth | map | output/state | Reported water volume for other fraction on catchment surface [m3] | +| lfbinding | WATER USE MAPS AND PAR | Population | $(Population) | map | input | Population per pixel | +| lfbinding | WATER USE MAPS AND PAR | PopulationMaps | $(PopulationMaps) | map | input | Population map for TransientLandUseChange | +| lfbinding | INFILTRATION | PowerPrefFlow | $(PowerPrefFlow) | map | input | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | +| lfbinding | INPUT METEO AND VEG MAPS | PrecipitationMaps | $(PathMeteo)/$(PrefixPrecipitation) | map | input | precipitation [mm/day] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | PrecipitationMapsOut | $(PathOut)/pr | map | output | Precipitation [mm per time step] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTEnd | $(PathOut)/prevcm.end | map | output/end | Reported Courant number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTState | $(PathOut)/prevcm | map | output/state | Reported Courant number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | input initial/internal | initial discharge from previous run for MCT diffusive routing -9999: use 0 | +| lfbinding | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTEnd | $(PathOut)/prevdm.end | map | output/end | Reported Raynolds number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTState | $(PathOut)/prevdm | map | output/state | Reported Reynolds number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | PrScaling | $(PrScaling) | value | input | Multiplier applied to potential precipitation rates | +| lfbinding | ROUTING | QSplitMult | $(QSplitMult) | value | input | PBchange Multiplier applied to average Q to split into a second line of routing | +| lfbinding | REPORTED OUTPUT MAPS (END) | ReservoirFillEnd | $(PathOut)/rsfil.end | map | output/end | Reported reservoir filling | +| lfbinding | RICE IRRIGATION | RiceFlooding | 10 | 0 | input | water amount in mm per day 10 mm for 10 days (total 10cm water) | +| lfbinding | RICE IRRIGATION | RiceHarvestDay1 | $(PathMapsTables)/riceharvestday1.map | map | input | map with starting day of the year | +| lfbinding | RICE IRRIGATION | RiceHarvestDay2 | $(PathMapsTables)/riceharvestday2.map | map | input | map with starting day of the year | +| lfbinding | RICE IRRIGATION | RicePercolation | 2 | 0 | input | FAO: percolation for heavy clay soils: PERC = 2 mm/day | +| lfbinding | RICE IRRIGATION | RicePlantingDay1 | $(PathMapsTables)/riceplantingday1.map | table | input | map with starting day of the year | +| lfbinding | RICE IRRIGATION | RicePlantingDay2 | $(PathMapsTables)/riceplantingday2.map | table | input | map with starting day of the year | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | SMaxSealed | $(SMaxSealed) | value | input | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] This storage is emptied by evaporation (EW0) | +| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverAEnd | $(PathOut)/scova.end | map | output/end | Reported snow cover in snow zone A [mm] | +| lfbinding | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | input initial/internal | initial snow depth in snow zone A [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverAState | $(PathOut)/scova | map | output/state | Reported snow cover in snow zone A [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverBEnd | $(PathOut)/scovb.end | map | output/end | Reported snow cover in snow zone B [mm] | +| lfbinding | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | input initial/internal | initial snow depth in snow zone B [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverBState | $(PathOut)/scovb | map | output/state | Reported snow cover in snow zone B [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverCEnd | $(PathOut)/scovc.end | map | output/end | Reported snow cover in snow zone C [mm] | +| lfbinding | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | input initial/internal | initial snow depth in snow zone C [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverCState | $(PathOut)/scovc | map | output/state | Reported snow cover in snow zone C [mm] | +| lfbinding | SNOW AND FROST | SnowFactor | $(SnowFactor) | 0 | input | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | +| lfbinding | SNOW AND FROST | SnowMeltCoef | $(SnowMeltCoef) | 0 | input | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | +| lfbinding | SNOW AND FROST | SnowSeasonAdj | $(SnowSeasonAdj) | 0 | input | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | +| lfbinding | SNOW AND FROST | SnowWaterEquivalent | $(SnowWaterEquivalent) | 0 | input | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | +| lfbinding | TIMESTEP RELATED PARAMETERS | StepEnd | $(StepEnd) | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | +| lfbinding | TIMESTEP RELATED PARAMETERS | StepStart | $(StepStart) | value/date | input | Step id number or date of the simulation start step. See code for a list of available date formats. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | +| lfbinding | WATER USE MAPS AND PAR | StepsWaterUseTS | $(StepsWaterUseTS) | tss | input | number of loops needed for water use routine | +| lfbinding | REPORTED OUTPUT MAPS | SurfaceSoilMoistureMaps | $(PathOut)/wta | map (missing) | output | Reported surface soil moisture [%] | +| lfbinding | INPUT METEO AND VEG MAPS | TavgMaps | $(PathMeteo)/$(PrefixTavg) | map | input | average daily temperature [C] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | TavgMapsOut | $(PathOut)/tav | map | output | Average DAILY temperature [degrees C] | +| lfbinding | SNOW AND FROST | TemperatureLapseRate | $(TemperatureLapseRate) | 0 | input | Temperature lapse rate with altitude [deg C / m] It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1] | +| lfbinding | SNOW AND FROST | TempMelt | $(TempMelt) | 0 | input | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | +| lfbinding | SNOW AND FROST | TempSnow | $(TempSnow) | 0 | input | It is the average temperature below which precipitation is assumed to be snow [°C] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1End | $(PathOut)/tha.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1ForestEnd | $(PathOut)/thfa.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a for forest [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1ForestState | $(PathOut)/thfa | map | output/state | theta for soil layer 1a forest fraction | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1IrrigationEnd | $(PathOut)/thia.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1IrrigationState | $(PathOut)/thia | map | output/state | Reported volumetric soil moisture content for soil layer 1a for irrigation[V/V] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta1Maps | $(PathOut)/thtop | map | output | Reported volumetric soil moisture content for soil layer 1 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1State | $(PathOut)/tha | map | output/state | Reported volumetric soil moisture content for soil layer 1 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2End | $(PathOut)/thb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2ForestEnd | $(PathOut)/thfb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b for forest [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2ForestState | $(PathOut)/thfb | map | output/state | theta for soil layer 1b forest fraction | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2IrrigationEnd | $(PathOut)/thib.end | map | output/end | Reported volumetric soil moisture content for soil layer 1b [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2IrrigationState | $(PathOut)/thib | map | output/state | Reported volumetric soil moisture content for both soil layer 1b for irrigation [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2State | $(PathOut)/thb | map | output/state | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3End | $(PathOut)/thc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3ForestEnd | $(PathOut)/thfc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3ForestState | $(PathOut)/thfc | map | output/state | theta for soil layer 2 forest fraction | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3IrrigationEnd | $(PathOut)/thic.end | map | output/end | Reported volumetric soil moisture content for soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3IrrigationState | $(PathOut)/thic | map | output/state | Reported volumetric soil moisture content for both soil layer 2 for irrigation [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta3Maps | $(PathOut)/thbot | map | output | Reported volumetric soil moisture content for soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3State | $(PathOut)/thc | map | output/state | Reported volumetric soil moisture content for both soil layer 3 [V/V] | +| lfbinding | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a for irrigation -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b for irrigation -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | input initial/internal | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | +| lfbinding | REPORTED OUTPUT MAPS | TopSoilMoistureMaps | $(PathOut)/wt | map (missing) | output | Reported Topsoil moisture [%] | +| lfbinding | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotalRunoffMaps | $(PathOut)/trun | map | output | Reported total runoff [mm/∆t] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotaltoChanMaps | $(PathOut)/ttoc | map | output | Reported total runoff that enters the channel: groundwater + surface runoff [mm/∆t] | +| lfbinding | TRANSMISSION LOSS | TransArea | $(TransArea) | 0 | input | PBchange downstream area taking into account for transmission loss | +| lfbinding | TRANSMISSION LOSS | TransPower1 | $(TransPower1) | 0 | input | PBchange Transmission loss function parameter | +| lfbinding | TRANSMISSION LOSS | TransSub | $(TransSub) | 0 | input | PBchange Transmission loss function parameter | +| lfbinding | TRANSMISSION LOSS | UpAreaTrans | $(UpAreaTrans) | 0 | input | upstream area for transmission loss | +| lfbinding | GROUNDWATER RELATED PAR | UpperZoneTimeConstant | $(UpperZoneTimeConstant) | map | input | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | +| lfbinding | REPORTED OUTPUT MAPS (END) | UZEnd | $(PathOut)/uz.end | map | output/end | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | UZForestEnd | $(PathOut)/uzf.end | map | output/end | Reported storage in upper groundwaterzone response box [mm] | +| lfbinding | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZForestState | $(PathOut)/uzf | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | input initial/internal | water in upper groundwater zone [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | UZIrrigationEnd | $(PathOut)/uzi.end | map | output/end | Reported storage in upper groundwater zone response box for irrigation [mm] | +| lfbinding | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZIrrigationState | $(PathOut)/uzi | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | UZMaps | $(PathOut)/uz | map | output | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | UZOutflowMaps | $(PathOut)/quz | map | output | Reported upper groundwater zone outflow [mm/∆t] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZState | $(PathOut)/uz | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | WaterDepthEnd | $(PathOut)/wdept.end | map | output/end | Reported overlandflow water depth | +| lfbinding | OUPUT | WaterDepthInitValue | $(WaterDepthInitValue) | map | input | initial overland flow water depth [mm] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | WaterDepthMaps | $(PathOut)/wdept | map | output | Reported water depth | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | WaterDepthState | $(PathOut)/wdept | map | output | Reported overland flow water depth | +| lfbinding | REPORTED OUTPUT MAPS | WaterLevelMaps | $(PathOut)/wl | map | output | Reported water level [m] | +| lfbinding | WATER USE MAPS AND PAR | WaterReUseFraction | $(WaterReUseFraction) | 0 | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | +| lfbinding | WATER USE MAPS AND PAR | WaterSavingFraction | $(WaterSavingFraction) | 0 | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | +| lfbinding | WATER USE MAPS AND PAR | WaterUseMaps | $(WaterUseMaps) | map | input | Reported water use m3 s-1 depending on the availability of discharge | +| lfbinding | WATER USE MAPS AND PAR | WaterUseTS | $(WaterUseTS) | tss | input | Time series of upstream water use at gauging stations | +| lfbinding | EVAPORATION FROM OPEN WATER | WFracOfDay | $(PathTables)/WFracOfDay.txt | map | input | table with days for each water use maps 1st column: range of days; 2nd column: suffix of wuse map | +| lfbinding | EVAPORATION FROM OPEN WATER | WFractionMaps | $(PathVarWaterfraction)/$(PrefixVarWaterFraction) | map | input | water use daily maps with a (in this case negative) volume of water [cu m/s] | +| lfbinding | WATER USE MAPS AND PAR | WUsePercRemain | $(WUsePercRemain) | value | input | percentage of water that must remain in a grid cell and is not withdrawn by water use e.g. 0.2 = 20 percent of discharge is not taken out | +| lfbinding | WATER USE MAPS AND PAR | WUseRegion | $(WUseRegion) | map | input | water use region | +| lfbinding | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | $(ChanBottomWMult) $(ChanDepthMult) $(ChanSMult) | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | +| lfbinding | INITIAL CONDITION | CumQEnd | $(CumQEnd) | map | output | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | CumQInit | $(CumQInit) | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestEnd | $(cumSeepTopToSubBForestEnd) | map | output | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationEnd | $(cumSeepTopToSubBIrrigationEnd) | map | output | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherEnd | $(cumSeepTopToSubBOtherEnd) | map | output | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | LZInflowCumEnd | $(LZInflowCumEnd) | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | value/map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfbinding | SETTINGS | MapsCaching | $(MapsCaching) | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | +| lfbinding | SETTINGS | NetCDFTimeChunks | $(NetCDFTimeChunks) | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | +| lfbinding | SETTINGS | NumDaysSpinUp | $(NumDaysSpinUp) | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | +| lfbinding | SETTINGS | OutputMapsChunks | $(OutputMapsChunks) | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | +| lfbinding | SETTINGS | OutputMapsDataType | $(OutputMapsDataType) | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | +| lfbinding | DOUBLE KINEMATIC WAVE | QSplitMult | $(QSplitMult) | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | +| lfbinding | RESERVOIRS | ReservoirFloodOutflowFactor | $(ReservoirFloodOutflowFactor) | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | +| lfbinding | RESERVOIRS | ReservoirFloodStorage | $(ReservoirFloodStorage) | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | +| lfbinding | SOIL INIT | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | +| lfbinding | SOIL INIT | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | +| lfbinding | SOIL INIT | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkEnd | $(TimeSinceStartPrerunChunkEnd) | map | output | Cumulative discharge. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | -| key | outputVar | unit | steps | all | end | monthly | restrictoption | Description | -|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|-------------|-----------------|-------------------------|-------------------------------|--------------------|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| LZAvInflowMap | LZAvInflow | mm | | | InitLisflood,repLZAvInflowMap | | | Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | -| DischargeMaps | ChanQAvg | m3/s | | repDischargeMaps | | | nonInit | Reported discharge [cu m/s] (average over the timesteps) | -| WaterLevelMaps | WaterLevel | m | | repWaterLevelMaps | | | nonInit,simulateWaterLevels | Reported water level [m] | -| AvgDis | avgdis | m3/s | | | repAverageDis | | nonInit | Average discharge map [m3/s] | -| AvgDis | avgdis | m3/s | | | InitLisflood | | SplitRouting | Average discharge map [m3/s] | -| WaterDepthState | WaterDepth | m | repStateMaps | | | | nonInit | Reported overland flow water depth | -| OFDirectState | OFM3Direct | m3 | repStateMaps | | | | nonInit | Reported water volume for direct fraction on catchment surface | -| OFOtherState | OFM3Other | m3 | repStateMaps | | | | nonInit | Reported water volume for other fraction on catchment surface | -| OFForestState | OFM3Forest | m3 | repStateMaps | | | | nonInit | Reported water volume for forest fraction on catchment surface | -| ChanCrossSectionState | TotalCrossSectionArea | m2 | repStateMaps | | | | nonInit | Reported chan cross-section area | -| DSLRState | DSLR[0] | - | repStateMaps | | | | nonInit | Reported days since last rain | -| DSLRForestState | DSLR[1] | - | repStateMaps | | | | nonInit | Reported days since last rain for forest | -| DSLRIrrigationState | DSLR[2] | - | repStateMaps | | | | nonInit | Reported days since last rain irrigation | -| SnowCoverAState | SnowCoverS[0] | mm | repStateMaps | | | | nonInit | Reported snow cover in snow zone A [mm] | -| SnowCoverBState | SnowCoverS[1] | mm | repStateMaps | | | | nonInit | Reported snow cover in snow zone B [mm] | -| SnowCoverCState | SnowCoverS[2] | mm | repStateMaps | | | | nonInit | Reported snow cover in snow zone C [mm] | -| FrostIndexState | FrostIndex | degC/day | repStateMaps | | | | nonInit | Reported frost index | -| CumInterceptionState | CumInterception[0] | mm | repStateMaps | | | | nonInit | Reported interception storage | -| CumInterceptionForestState | CumInterception[1] | mm | repStateMaps | | | | nonInit | Reported interception storage for forest | -| CumInterceptionIrrigationState | CumInterception[2] | mm | repStateMaps | | | | nonInit | Reported interception storage | -| Theta1State | Theta1a[0] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for superficial soil layer 1 [V/V] | -| Theta1ForestState | Theta1a[1] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for superficial soil layer forest fraction [V/V] | -| Theta1IrrigationState | Theta1a[2] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for superficial soil layer irrigation fraction [V/V] | -| Theta2State | Theta1b[0] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for upper layer [V/V] | -| Theta2ForestState | Theta1b[1] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for upper layer forest fraction [V/V] | -| Theta2IrrigationState | Theta1b[2] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for upper soil layer irrigation fraction [V/V] | -| Theta3State | Theta2[0] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for lower soil layer [V/V] | -| Theta3ForestState | Theta2[1] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for lower soil layer forest fraction [V/V] | -| Theta3IrrigationState | Theta2[2] | - | repStateMaps | | | | nonInit | Reported volumetric soil moisture content for lower soil layer irrigation fraction [V/V] | -| UZState | UZ[0] | mm | repStateMaps | | | | nonInit | Reported storage in upper groundwater zone response box [mm] | -| UZForestState | UZ[1] | mm | repStateMaps | | | | nonInit | Reported storage in upper groundwater zone response box [mm] | -| UZIrrigationState | UZ[2] | mm | repStateMaps | | | | nonInit | Reported storage in upper groundwater zone response box [mm] | -| LZState | LZ | mm | repStateMaps | | | | nonInit | Reported storage in lower response box [mm] | -| CumIntSealedState | CumInterSealed | mm | repStateMaps | | | | nonInit | Reported cumulative depressions storage [mm] | -| DischargeMaps | ChanQAvg | m3/s | repStateMaps | | | | nonInit | Reported discharge [cu m/s] (average over the timesteps) | -| ChanQState | ChanQ | m3/s | repStateMaps | | | | nonInit | Reported istantaneous discarge at end of time step | -| ChanQAvgDtState | ChanQAvgDt | m3/s | repStateMaps | | | | nonInit | Reported average discharge for the last sub routing step | -| PrevCmMCTState | PrevCm0 | - | repStateMaps | | | | nonInit | Reported Courant number at previous step for MCT routing | -| PrevDmMCTState | PrevDm0 | - | repStateMaps | | | | nonInit | Reported Reynolds number at previous step for MCT routing | -| LakeLevelState | LakeLevel | m | repStateMaps | | | | nonInit,simulateLakes | Output map(s) with lake level [m] | -| ReservoirFillState | ReservoirFill | - | repStateMaps | | | | nonInit,simulateReservoirs | Output map(s) with Reservoir Filling [-] | -| CrossSection2State | CrossSection2Area | m | repStateMaps | | | | nonInit,SplitRouting | Cross section area for split routing [m2] | -| ChSideState | Sideflow1Chan | m^2/s | repStateMaps | | | | nonInit, SplitRouting | Sideflow to channel for 1st line of routing [m^2/s] | -| PolderLevelState | PolderLevel | m | repStateMaps | | | | nonInit,simulatePolders | Output map(s) with polder level | -| WaterDepthEnd | WaterDepth | m | | | repEndMaps | | nonInit | Reported overlandflow water depth | -| OFDirectEnd | OFM3Direct | m^3 | | | repEndMaps | | nonInit | Reported water volume for direct fraction on catchment surface | -| OFOtherEnd | OFM3Other | m^3 | | | repEndMaps | | nonInit | Reported water volume for other fraction on catchment surface | -| OFForestEnd | OFM3Forest | m^3 | | | repEndMaps | | nonInit | Reported water volume for forest fraction on catchment surface | -| ChanCrossSectionEnd | TotalCrossSectionArea | m2 | | | repEndMaps | | nonInit | Reported chan cross-section area | -| DSLREnd | DSLR[0] | days | | | repEndMaps | | nonInit | Reported days since last rain | -| DSLRForestEnd | DSLR[1] | days | | | repEndMaps | | nonInit | Reported days since last rain for forest fraction | -| DSLRIrrigationEnd | DSLR[2] | days | | | repEndMaps | | nonInit | Reported days since last rain for irrigation fraction | -| SnowCoverAEnd | SnowCoverS[0] | mm | | | repEndMaps | | nonInit | Reported snow cover in snow zone A [mm] | -| SnowCoverBEnd | SnowCoverS[1] | mm | | | repEndMaps | | nonInit | Reported snow cover in snow zone B [mm] | -| SnowCoverCEnd | SnowCoverS[2] | mm | | | repEndMaps | | nonInit | Reported snow cover in snow zone C [mm] | -| FrostIndexEnd | FrostIndex | degC/day | | | repEndMaps | | nonInit | Reported frost index | -| CumInterceptionEnd | CumInterception[0] | mm | | | repEndMaps | | nonInit | Reported interception storage | -| CumInterceptionForestEnd | CumInterception[1] | mm | | | repEndMaps | | nonInit | Reported interception storage for forest | -| CumInterceptionIrrigationEnd | CumInterception[2] | mm | | | repEndMaps | | nonInit | Reported interception storage for irrigation | -| Theta1End | Theta1a[0] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for superficial soil layer [V/V] | -| Theta1ForestEnd | Theta1a[1] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for uperficial soil layer for forest [V/V] | -| Theta1IrrigationEnd | Theta1a[2] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for uperficial soil layer [V/V] | -| Theta2End | Theta1b[0] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for upper soil layer [V/V] | -| Theta2ForestEnd | Theta1b[1] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for upper soil layer for forest [V/V] | -| Theta2IrrigationEnd | Theta1b[2] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for upper soil layer [V/V] | -| Theta3End | Theta2[0] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for lower soil layer [V/V] | -| Theta3ForestEnd | Theta2[1] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for lower soil layer [V/V] | -| Theta3IrrigationEnd | Theta2[2] | mm | | | repEndMaps | | nonInit | Reported volumetric soil moisture content for lower soil layer [V/V] | -| UZEnd | UZ[0] | mm | | | repEndMaps | | nonInit | Reported storage in upper groundwater zone response box [mm] | -| UZForestEnd | UZ[1] | mm | | | repEndMaps | | nonInit | Reported storage in upper groundwaterzone response box [mm] | -| UZIrrigationEnd | UZ[2] | mm | | | repEndMaps | | nonInit | Reported storage in upper groundwater zone response box for irrigation [mm] | -| LZEnd | LZ | mm | | | repEndMaps | | nonInit | Reported storage in lower groundwater zone response box [mm] | -| CumIntSealedEnd | CumInterSealed | mm | | | repEndMaps | | nonInit | Reported cumulative depressions storage [mm] | -| DischargeEnd | ChanQAvg | m3/s | | | repEndMaps | | nonInit | Reported discharge [cu m/s] (average over the timesteps) | -| ChanQEnd | ChanQ | m3/s | | | repEndMaps | | nonInit | Reported istantaneous discarge at end of time step | -| ChanQAvgDtEnd | ChanQAvgDt | m3/s | | | repEndMaps | | nonInit | Reported average discharge for the last sub-routing step | -| PrevCmMCTEnd | PrevCm0 | - | | | repEndMaps | | nonInit | Reported Courant number at previous step for MCT routing | -| PrevDmMCTEnd | PrevDm0 | - | | | repEndMaps | | nonInit | Reported Reynolds number at previous step for MCT routing | -| LakeLevelEnd | LakeLevel | m | | | repEndMaps | | nonInit,simulateLakes | Reported lake level | -| ReservoirFillEnd | ReservoirFill | m | | | repEndMaps | | nonInit,simulateReservoirs | Reported reservoir filling | -| CrossSection2End | CrossSection2Area | m | | | repEndMaps | | nonInit,SplitRouting | Cross section area for split routing [m2] | -| ChSideEnd | Sideflow1Chan | m | | | repEndMaps | | nonInit,SplitRouting | Reported channel side flow | -| PolderLevelEnd | PolderLevel | m | | | repEndMaps | | nonInit,simulatePolders | Output map(s) with polder level | -| PrecipitationMapsOut | Precipitation | mm/timestep | | repPrecipitationMaps | | | | Precipitation [mm per time step] | -| TavgMapsOut | Tavg | degree | | repTavgMaps | | | | Average DAILY temperature [degrees C] | -| ETRefMapsOut | ETRef | mm | | repETRefMaps | | | | Potential reference evapotranspiration [mm per time step] | -| ESRefMapsOut | ESRef | mm | | repESRefMaps | | | | Potential evaporation from bare soil surface [mm per time step] | -| EWRefMapsOut | EWRef | mm | | repEWRefMaps | | | | Potential evaporation from open water surface [mm per time step] | -| WaterDepthMaps | WaterDepth | m | | repWaterDepthMaps | | | nonInit | Reported water depth | -| OFDirectMaps | OFM3Direct | m3 | | repWaterDepthMaps | | | nonInit | Reported water volume for direct fraction on catchment surface | -| OFOtherMaps | OFM3Other | m3 | | repWaterDepthMaps | | | nonInit | Reported water volume for other fraction on catchment surface | -| OFForestMaps | OFM3Forest | m3 | | repWaterDepthMaps | | | nonInit | Reported water volume for forest fraction on catchment surface | -| ChanCrossSectionMaps | TotalCrossSectionArea | m2 | | repChanCrossSectionMaps | | | nonInit | Reported chan cross-section area | -| DSLRMaps | DSLR[0] | | | repDSLRMaps | | | nonInit | Reported days since last rain | -| DSLRForestMaps | DSLR[1] | | | repDSLRMaps | | | nonInit | Reported days since last rain | -| SnowCoverMaps | SnowCover | mm | | repSnowCoverMaps | | | nonInit | Reported snow cover | -| FrostIndexMaps | FrostIndex | degC/day | | repFrostIndexMaps | | | nonInit | Reported frost index | -| CumInterceptionMaps | CumInterception[0] | mm | | repCumInterCeptionMaps | | | nonInit | Reported interception storage | -| Theta1Maps | Theta1a[0] | - | | repThetaMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 1a [V/V] | -| Theta1ForestMaps | Theta1a[1] | - | | repThetaForestMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 1a forest fraction [V/V] | -| Theta1IrrigationMaps | Theta1a[2] | - | | repThetaIrrigationMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 1a irrigation fraction [V/V] | -| Theta2Maps | Theta1b[0] | - | | repThetaMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| Theta2ForestMaps | Theta1b[1] | - | | repThetaForestMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 1b forest fraction [V/V] | -| Theta2IrrigationMaps | Theta1b[2] | - | | repThetaIrrigationMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 1b irrigation fraction [V/V] | -| Theta3Maps | Theta2[0] | - | | repThetaMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| Theta3ForestMaps | Theta2[1] | - | | repThetaForestMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 2 forest fraction [V/V] | -| Theta3IrrigationMaps | Theta2[2] | - | | repThetaIrrigationMaps | | | nonInit | Reported volumetric soil moisture content for soil layer 2 irrigation fraction [V/V] | -| UZMaps | UZ[0] | mm | | repUZMaps | | | nonInit | Reported storage in upper groundwater zone response box [mm] | -| UZForestMaps | UZ[1] | mm | | repUZMaps | | | nonInit | Reported storage in upper response box [mm] | -| LZMaps | LZ | mm | | repLZMaps | | | nonInit | Reported storage in lower groundwater zone response box [mm] | -| RainMaps | Rain | mm | | repRainMaps | | | nonInit | Reported rain (excluding snow)[mm/∆t] | -| SnowMaps | Snow | mm | | repSnowMaps | | | nonInit | Reported snow (excluding rain)[mm/∆t] | -| SnowMeltMaps | SnowMelt | mm | | repSnowMeltMaps | | | nonInit | Reported snowmelt [mm/∆t] | -| InterceptionMaps | Interception[0] | mm | | repInterceptionMaps | | | nonInit | Reported interception [mm/∆t] | -| InterceptionForestMaps | Interception[1] | mm | | repInterceptionMaps | | | nonInit | Reported interception forest [mm/∆t] | -| EWIntMaps | TaInterception[0] | mm | | repEWIntMaps | | | nonInit | Reported evaporation of intercepted water [mm/∆t] | -| EWIntForestMaps | TaInterception[1] | mm | | repEWIntMaps | | | nonInit | Reported evaporation of intercepted water [mm/∆t] | -| LeafDrainageMaps | LeafDrainage[0] | mm | | repLeafDrainageMaps | | | nonInit | Reported leaf drainage [mm/∆t] | -| LeafDrainageForestMaps | LeafDrainage[1] | mm | | repLeafDrainageMaps | | | nonInit | Reported leaf drainage Forest [mm/∆t] | -| TaMaps | Ta[0] | mm | | repTaMaps | | | nonInit | Reported transpiration [mm/∆t] | -| TaForestMaps | Ta[1] | mm | | repTaMaps | | | nonInit | Reported transpiration forest [mm/∆t] | -| ESActMaps | ESAct[0] | mm | | repESActMaps | | | nonInit | Reported soil evaporation [mm/∆t] | -| ESActForestMaps | ESAct[1] | mm | | repESActMaps | | | nonInit | Reported soil evaporation [mm/∆t] | -| InfiltrationMaps | Infiltration[0] | mm | | repInfiltrationMaps | | | nonInit | Reported infiltration [mm/∆t] | -| InfiltrationForestMaps | Infiltration[1] | mm | | repInfiltrationMaps | | | nonInit | Reported infiltration for forest [mm/∆t] | -| PrefFlowMaps | PrefFlow[0] | mm | | repPrefFlowMaps | | | nonInit | Reported preferential flow [mm/∆t] | -| PrefFlowForestMaps | PrefFlow[1] | mm | | repPrefFlowMaps | | | nonInit | Reported preferential flow [mm/∆t] | -| PercolationMaps | SeepTopToSub[0] | mm | | repPercolationMaps | | | nonInit | Reported percolation from 1st to 2nd soil layer [mm/∆t] | -| PercolationForestMaps | SeepTopToSub[1] | mm | | repPercolationMaps | | | nonInit | Reported percolation from 1st to 2nd soil layer for forest [mm/∆t] | -| SeepSubToGWMaps | SeepSubToGW[0] | mm | | repSeepSubToGWMaps | | | nonInit | Reported seepage to groundwater [mm/∆t] | -| SeepSubToGWForestMaps | SeepSubToGW[1] | mm | | repSeepSubToGWMaps | | | nonInit | Reported seepage to groundwater for forest [mm/∆t] | -| UZOutflowMaps | UZOutflowPixel | mm | | repUZOutflowMaps | | | nonInit | Reported upper groundwater zone outflow [mm/∆t] | -| UZOutflowForestMaps | UZOutflowPixel | mm | | repUZOutflowMaps | | | nonInit | Reported upper groundwater zone outflow [mm/∆t] | -| LZOutflowMaps | LZOutflowToChannelPixel | mm | | repLZOutflowMaps | | | nonInit | Reported lower groundwater zone outflow [mm/∆t] | -| GwPercUZLZMaps | GwPercUZLZ[0] | mm | | repGwPercUZLZMaps | | | nonInit | Reported percolation from upper to lower groundwater zone [mm/∆t] | -| GwPercUZLZForestMaps | GwPercUZLZ[1] | mm | | repGwPercUZLZMaps | | | nonInit | Reported percolation from upper to lower groundwater zone [mm/∆t] | -| GwLossMaps | GwLossPixel | mm | | repGwLossMaps | | | nonInit | Reported GWloss [mm/∆t] | -| DirectRunoffMaps | DirectRunoff | mm | | repSurfaceRunoffMaps | | | nonInit | Reported Direct Runoff [mm/∆t] | -| SurfaceRunoffMaps | SurfaceRunoff | mm | | repSurfaceRunoffMaps | | | nonInit | Reported surface runoff [mm/∆t] | -| TotalRunoffMaps | TotalRunoff | mm | | repSurfaceRunoffMaps | | | nonInit | Reported total runoff [mm/∆t] | -| TotalToChanMaps | ToChanM3Runoff*self.var.M3toMM | mm | | repSurfaceRunoffMaps | | | nonInit | Reported total runoff that enters the channel: groundwater + surface runoff [mm/∆t] | -| FastRunoffMaps | SurfaceRunoff+self.var.UZOutflowPixel | mm | | repSurfaceRunoffMaps | | | nonInit | Reported fast runoff = surface + UZ [mm/∆t] | -| FlowVelocityMSecMaps | FlowVelocity | m/s | | repSurfaceRunoffMaps | | | nonInit | Reported FlowVelocityMSecMaps [m/s] | -| TravelDistanceMMaps | TravelDistance | m | | repSurfaceRunoffMaps | | | nonInit | Reported TravelDistance [m] | -| PF1Maps | pF0[0] | mm | repPFMaps | | | | nonInit,simulatePF | Reported pF 1st upper soil layer [-] | -| PF1ForestMaps | pF0[1] | mm | repPFForestMaps | | | nonInit,simulatePF | Reported pF upper soil layer for forest [-] | | -| PF2Maps | pF1[0] | mm | repPFMaps | | | | nonInit,simulatePF | Reported pF 2nd upper soil layer [-] | -| PF2ForestMaps | pF1[1] | mm | repPFForestMaps | | | nonInit,simulatePF | Reported pF lower soil layer for forest [-] | | -| PF3Maps | pF2[0] | mm | repPFMaps | | | | nonInit,simulatePF | Reported pF 3rd soil layer [-] | -| SMStressMap | SoilMoistureStressDays[0] | days | repStressDays | | | | nonInit | Reported number of days in simulation with soil moisture stress [days] | -| SMStressForestMap | SoilMoistureStressDays[1] | days | repStressDays | | | | nonInit | Reported number of days in simulation with soil moisture stress for forest fraction [days] | -| ETActMaps | ESActPixel+self.var.TaPixel+self.var.TaInterceptionAll+self.var.EvaAddM3*self.var.M3toMM | mm | | repE2O1 | | | nonInit | Reported actual evapotranspiration [mm/∆t] | -| TaMaps | TaPixel | mm | | repE2O1 | | | nonInit | Reported transpiration [mm/∆t] | -| ESActMaps | ESActPixel | mm | | repE2O1 | | | nonInit | Reported soil evaporation [mm/∆t] | -| EWIntMaps | TaInterceptionAll | mm | | repE2O1 | | | nonInit | Reported evaporation of intercepted water [mm/∆t] | -| EWater | EvaAddM3*self.var.M3toMM | mm | | repE2O1 | | | nonInit | ? | -| RainMaps | Rain | mm | | repE2O1 | | | nonInit | Reported rain (excluding snow)[mm/∆t] | -| SnowMeltMaps | SnowMelt | mm | | repE2O1 | | | nonInit | Reported snowmelt [mm/∆t] | -| SnowCoverMaps | SnowCover | mm | | repE2O1 | | | nonInit | Reported snow cover | -| TotalRunoffMaps | ToChanM3Runoff*self.var.M3toMM | mm | | repE2O1 | | | nonInit | Reported total runoff [mm/∆t] | -| FastRunoffMaps | SurfaceRunoff+self.var.UZOutflowPixel | mm | | repE2O1 | | | nonInit | Reported fast runoff = surface + UZ [mm/∆t] | -| LZOutflowMaps | LZOutflowToChannelPixel | mm | | repE2O1 | | | nonInit | Reported lower groundwater zone outflow [mm/∆t] | -| LZMaps | LZ | mm | | repE2O2 | | | nonInit | Reported storage in lower groundwater zone response box [mm] | -| GwLossMaps | GwLossPixel | mm | | repE2O2 | | | nonInit | Reported GWloss [mm/∆t] | -| PrefFlowMaps | PrefFlowPixel | mm | | repE2O2 | | | nonInit | Reported preferential flow [mm/∆t] | -| SeepSubToGWMaps | SeepSubToGWPixel | mm | | repE2O2 | | | nonInit | Reported seepage to groundwater [mm/∆t] | -| GwPercUZLZMaps | GwPercUZLZPixel | mm | | repE2O2 | | | nonInit | Reported percolation from upper to lower groundwater zone [mm/∆t] | -| WaterUseMaps | WUseAddM3*self.var.M3toMM | mm | | repE2O2 | | | nonInit | path and prefix of the reported water use m3 s-1 as a result of demand and availability | -| Theta1Maps | Theta1a[0] | mm | | repE2O2 | | | nonInit | Reported volumetric soil moisture content for soil layer 1 [V/V] | -| Theta2Maps | Theta1b[0] | mm | | repE2O2 | | | nonInit | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| Theta3Maps | Theta2[0] | mm | | repE2O2 | | | nonInit | Reported volumetric soil moisture content for soil layer 3 [V/V] | -| TotalAbsGroundwater | TotalAbstractionFromGroundwaterM3*self.var.M3toMM | mm | repTotalAbs | | | | nonInit,wateruse | TotalAbstractionFromGroundwater [mm] | -| TotalAbsSurface | TotalAbstractionFromSurfaceWaterM3*self.var.M3toMM | mm | repTotalAbs | | | | nonInit,wateruse | TotalAbstractionFromSurfaceWater [mm] | -| TotalAbsSurfaceRegion | AreaTotalAbstractionFromSurfaceWaterM3*self.var.M3toMM | mm | repTotalAbs | | | | nonInit,wateruse,wateruseRegion | TotalAbstractionFromSurfaceWater [mm] summed up for water regions | -| TotalAbsGroundwaterRegion | AreaTotalAbstractionFromGroundwaterM3*self.var.M3toMM | mm | repTotalAbs | | | | nonInit,wateruse,wateruseRegion | TotalAbstractionFromGroundwater [mm] summed up for water regions | -| TotalIrrigationAbstractionM3 | TotalIrrigationAbstractionM3 | m3 | repTotalAbs | | | | nonInit,wateruse | TotalIrrigationAbstraction [m3] | -| TotalPaddyRiceIrrigationAbstractionM3 | TotalPaddyRiceIrrigationAbstractionM3 | m3 | repTotalAbs | | | | nonInit,wateruse | TotalPaddyRiceIrrigationAbstraction [m3] | -| TotalLivestockAbstractionM3 | TotalLivestockAbstractionM3 | m3 | repTotalAbs | | | | nonInit,wateruse | TotalLivestockAbstraction [m3] | -| DomesticConsumptiveUse | DomesticConsumptiveUseMM | mm | repTotalAbs | | | | nonInit,wateruse | DomesticConsumptiveUseMM [mm] | -| LivestockConsumptiveUse | LivestockConsumptiveUseMM | mm | repTotalAbs | | | | nonInit,wateruse | LivestockConsumptiveUseMM [mm] | -| IndustrialConsumptiveUse | IndustrialConsumptiveUseMM | mm | repTotalAbs | | | | nonInit,wateruse | IndustrialConsumptiveUseMM [mm] | -| EnergyConsumptiveUse | EnergyConsumptiveUseMM | mm | repTotalAbs | | | | nonInit,wateruse | EnergyConsumptiveUseMM [mm] | -| IrrigationWaterAbstraction | IrrigationWaterAbstractionM3*self.var.M3toMM + self.var.PaddyRiceWaterAbstractionFromSurfaceWaterM3*self.var.M3toMM | mm | repTotalAbs | | | | nonInit,wateruse | IrrigationWaterAbstraction [mm] | -| TotalWUse | WUseAddM3*self.var.M3toMM | mm | repTotalWUse | | | | nonInit,wateruse | Water use (water demand is reduced by water available | -| TotalWUseRegion | totalAddM3*self.var.M3toMM | mm | repTotalWUse | | | | nonInit,wateruse,wateruseRegion | Water use (water demand is reduced by water available) summed up for water regions | -| WEI_Cns | WEI_Cns | - | repWIndex | | | TRUE | nonInit,wateruse,indicator | Water Exploitation Index - Consumption; for water regions (this is the official EU WEI+): consumption / internal and external availability | -| WEI_Abs | WEI_Abs | - | repWIndex | | | TRUE | nonInit,wateruse,indicator | Water Exploitation Index - Abstraction; for water regions: abstraction / internal and external availability | -| WEI_Dem | WEI_Dem | - | repWIndex | | | TRUE | nonInit,wateruse,indicator | Water Exploitation Index - Demand; for water regions: demand / internal and external availability | -| RegionMonthReservoirAndLakeStorageM3 | RegionMonthReservoirAndLakeStorageM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | Reservoir and Lake storage in m3 at end of month | -| RegionMonthWaterAbstractedfromLakesReservoirsM3 | RegionMonthWaterAbstractedfromLakesReservoirsM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | Reservoir and Lake abstraction in m3 | -| RegionMonthIrrigationShortageM3 | RegionMonthIrrigationShortageM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | Irrigation water shortage in m3 for month | -| RegionMonthInternalFlowM3 | RegionMonthInternalFlowM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | Internal available water | -| RegionMonthExternalInflowM3 | RegionMonthExternalInflowM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | External available water | -| RegionMonthWConsumptionM3 | RegionMonthWConsumptionM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | Region Water Consumption | -| RegionMonthWAbstractionM3 | RegionMonthWAbstractionM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | Region Water Demand | -| RegionMonthWDemandM3 | RegionMonthWDemandM3 | M3 | repWIndex | | | TRUE | nonInit,wateruse,wateruseRegion,indicator | Region Water Demand | -| MonthETpotMM | MonthETpotMM | mm | repWIndex | | | TRUE | nonInit,wateruse,,indicator | Monthly evapotranspiration deficit in mm | -| MonthETactMM | MonthETactMM | mm | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly evapotranspiration deficit in mm | -| MonthETdifMM | MonthETdifMM | mm | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly evapotranspiration deficit in mm | -| WaterDependencyIndex | WaterDependencyIndex | - | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly Water Dependency Index (0-1) (De Roo 2015) WDI = Upstream Inflow Actually Used / Total Water Demand Values close to 1 give extreme dependency on upstream water | -| WaterSecurityIndex | WaterSecurityIndex | - | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly Water Security Index (0-1) (De Roo 2015) WSI = Upstream Inflow Actually Used / Upstream Inflow Available Values close to 1 give extreme vulnerability to upstream water | -| WaterSustainabilityIndex | WaterSustainabilityIndex | - | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly Water Sustainability Index (0-1) (De Roo 2015) WTI = 1-SurfaceWaterDeficit / TotalWaterDemand Values of 1 indicate complete sustainable conditions, no water deficit Values less than 1 indicate that considerable deep groundwater resources or desalinated water is used | -| FalkenmarkM3Capita1 | FalkenmarkM3Capita1 | M3Capita | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly Falkenmark 1 Index (tochanm3) | -| FalkenmarkM3Capita2 | FalkenmarkM3Capita2 | M3Capita | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly Falkenmark 2 Index (tochanm3+reservoirlakeabstraction) | -| FalkenmarkM3Capita3 | FalkenmarkM3Capita3 | M3Capita | repWIndex | | | TRUE | nonInit,wateruse,indicator | Monthly Falkenmark 3 Index (tochanm3+reservoirlakeabstraction+externalinflow) | -| TotalAbstractionFromGroundwaterM3 | TotalAbstractionFromGroundwaterM3 | m3 | repTotalAbs | | | | nonInit,wateruse | Abstraction from groundwater in m3 per timestep | -| TotalAbstractionFromSurfaceWaterM3 | TotalAbstractionFromSurfaceWaterM3 | m3 | repTotalAbs | | | | nonInit,wateruse | Abstraction from surface water in m3 per timestep | -| PotentialSurfaceWaterAvailabilityForIrrigationM3 | PotentialSurfaceWaterAvailabilityForIrrigationM3 | m3 | repTotalAbs | | | | nonInit,wateruse | Surface water availability in m3 for potential irrigation for each day | -| TotalAbsGroundwater | TotalAbstractionFromGroundwaterM3*self.var.M3toMM | mm | repTotalAbs | | | | nonInit,wateruse | TotalAbstractionFromGroundwater [mm] | -| AreaTotalAbstractionFromSurfaceWaterM3 | AreaTotalAbstractionFromSurfaceWaterM3 | m3 | repTotalAbs | | | | nonInit,wateruse | AreaTotalAbstractionFromSurfaceWaterM3 | -| AreaTotalAbstractionFromGroundwaterM3 | AreaTotalAbstractionFromGroundwaterM3 | m3 | repTotalAbs | | | | nonInit,wateruse | Region abstraction from groundwater in m3 per timestep | -| AreatotalWaterAbstractedfromLakesReservoirsM3 | AreatotalWaterAbstractedfromLakesReservoirsM3 | m3 | repTotalAbs | | | | nonInit,wateruse | Region Total Abstraction From Lakes and Reservoirs in m3, per timestep | -| LakeAbstractionM3 | LakeAbstractionM3 | m3 | repTotalAbs | | | | nonInit,wateruse,simulateLakes | Lake Abstraction per timestep in m3 | -| ReservoirAbstractionM3 | ReservoirAbstractionM3 | m3 | repTotalAbs | | | | nonInit,wateruse,simulateReservoirs | ReservoirAbstraction per timestep in M3 | -| LakeStorageM3 | LakeStorageM3 | m3 | repTotalAbs | | | | nonInit,wateruse,simulateLakes | Reported lake storage | -| ReservoirStorageM3 | ReservoirStorageM3 | m3 | repTotalAbs | | | | nonInit,wateruse,simulateReservoirs | ReservoirStorage in M3 | -| TotalDemandM3 | TotalDemandM3 | m3 | repTotalAbs | | | | nonInit,wateruse | Total Abstraction Demand | -| WUseAddM3 | WUseAddM3 | m3 | repTotalAbs | | | | nonInit,wateruse | WUseAddM3 | -| totalAddM3 | totalAddM3 | m3 | repTotalAbs | | | | nonInit,wateruse | totalAddM3 | -| AreatotalIrrigationUseM3 | AreatotalIrrigationUseM3 | m3 | repTotalAbs | | | | nonInit,wateruse | AreatotalIrrigationUseM3 | -| FractionAbstractedFromChannels | FractionAbstractedFromChannels | - | repTotalAbs | | | | nonInit,wateruse | FractionAbstractedFromChannels | -| EFlowIndicator | EFlowIndicator | - | repTotalAbs | | | | nonInit,wateruse,indicator | EFlowIndicator (1 on day with ChanQ smaller than EflowThreshold, 0 on normal days) | + +##**Table:** *Variables required for model initialization.* + +| section (XML) | module | KEY | In settings xml | Type | Cold Start: prerun and run | Warm Start: preun | Warm Start: run | Description | +|:------------------------|:-------------------------------------------|:----------------------------------------|:----------------------------------------------|:-----------------------------|:---------------------------------------------------------------|:---------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :--------------------------- | :--------------------------- | :--------------------------- | :--------------------------- | :--------------------------- | +| --------------- | ------------------------------------ | --------------------------------- | --------------- | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| lfuser | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | -9999 | ch2cro.end.nc | ch2cro.end.nc | initial channel crosssection for 2nd routing channel -9999: use 0 | +| lfuser | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | 0 | cumf.end.nc | cumf.end.nc | cumulative interception forest [mm] | +| lfuser | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | 0 | cum.end.nc | cum.end.nc | cumulative interception [mm] | +| lfuser | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | 0 | cumi.end.nc | cumi.end.nc | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| lfuser | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | 0 | cseal.end.nc | cseal.end.nc | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| lfuser | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | 1 | dslf.end.nc | dslf.end.nc | initial number of days since the last rainfall event for forest [days] | +| lfuser | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | 1 | dslr.end.nc | dslr.end.nc | days since last rainfall | +| lfuser | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | 1 | dsli.end.nc | dsli.end.nc | initial number of days since the last rainfall event for irrigation [days] | +| lfuser | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | 0 | frost.end.nc | frost.end.nc | initial frost index value | +| lfuser | INITIAL CONDITION | LZAvInflowMap | $(PathMaps)/lzavin.map | value/map | run: lzavin.nc; prerun: not needed | Not needed | Not needed | Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | +| lfuser | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | 0 | ofdir.end.nc | ofdir.end.nc | Reported water volume for direct fraction on catchment surface [m^3] | +| lfuser | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | 0 | offor.end.nc | offor.end.nc | Reported water volume for other fraction on catchment surface [m^3] | +| lfuser | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | 0 | ofoth.end.nc | ofoth.end.nc | Reported water volume for forest fraction on catchment surface [m^3] | +| lfuser | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | -9999 | prevcm.end.nc | prevcm.end.nc | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| lfuser | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | -9999 | chanq.end.nc | chanq.end.nc | initial discharge from previous run for MCT diffusive routing -9999: use 0 | +| lfuser | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | -9999 | chanqavgdt.end.nc | chanqavgdt.end.nc | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | +| lfuser | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | -9999 | prevdm.end.nc | prevdm.end.nc | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| lfuser | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | -9999 | chside.end.nc | chside.end.nc | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| lfuser | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | 0 | scova.end.nc | scova.end.nc | initial snow depth in snow zone A [mm] | +| lfuser | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone B [mm] | +| lfuser | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone C [mm] | +| lfuser | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | thf1.end.nd, prerun outpit (preferred0); -9999 | thf1.end.nc | thf1.end.nc | initial soil moisture content layer 1, forest -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | thf2.end.nd, prerun outpit (preferred0); -9999 | thf2.end.nc | thf2.end.nc | initial soil moisture content layer 2, forest -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | thf3.end.nd, prerun outpit (preferred0); -9999 | thf3.end.nc | thf3.end.nc | initial soil moisture content layer 3, forest -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | th1.end.nd, prerun outpit (preferred0); -9999 | th1.end.nc | th1.end.nc | initial soil moisture content layer 1, other fraction -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | th2.end.nd, prerun outpit (preferred0); -9999 | th2.end.nc | th2.end.nc | initial soil moisture content layer 2, other fraction -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | th3.end.nd, prerun outpit (preferred0); -9999 | th3.end.nc | th3.end.nc | initial soil moisture content layer 3, other fraction -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | thi1.end.nd, prerun outpit (preferred0); -9999 | thi1.end.nc | thi1.end.nc | initial soil moisture content layer 1, irrigation -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | thi2.end.nd, prerun outpit (preferred0); -9999 | thi2.end.nc | thi2.end.nc | initial soil moisture content layer 2, irrigation -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | thi3.end.nd, prerun outpit (preferred0); -9999 | thi3.end.nc | thi3.end.nc | initial soil moisture content layer 3, irrigation -9999: use field capacity values | +| lfuser | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | Not Needed | value/date | value/date | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | +| lfuser | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | -9999 | chcro.end.nc | chcro.end.nc | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | +| lfuser | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | 0 | uzf.end.nc | uzf.end.nc | Initial water storage water in upper groundwater zone for forest [mm] | +| lfuser | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | 0 | uz.end.nc | uz.end.nc | water in upper groundwater zone [mm] | +| lfuser | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | 0 | uzi.end.nc | uzi.end.nc | Initial water storage water in upper groundwater zone for irrigation [mm] | +| lfuser | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | 0 | cumSeepTopToSubBForest.end.nc | Not needed | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | 0 | cumSeepTopToSubBIrrigated.end.nc | Not needed | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | 0 | cumSeepTopToSubBOther.end.nc | Not needed | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | map | 0 | LZInflowCum.end.nc | Not needed | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfuser | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | 0 | TimeSinceStartPrerunChunk.end.nc | Not needed | Cumulative discharge. Required for the warm start of the pre-run. | +| lfuser | INITIAL CONDITION | CumQInit | $(CumQInit) | map | 0 | CumQEnd.nc | Not needed | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | run: SeepTopToSubBAverageForestMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | run: SeepTopToSubBAverageIrrigationMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | run: SeepTopToSubBAverageOtherMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | AvgDis | $(PathMaps)/avgdis.map | map | run: avgdis.nc; prerun: not needed | Not needed | Not needed | Reported map of average discharge (reported for end of simulation) | +| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | -9999 | lz.end.nc | lz.end.nc | water in lower store [mm] -9999: use steady-state storage | From dd9b6351b7905708f476781d74d413f7a3359f38 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 13 May 2026 19:07:44 +0200 Subject: [PATCH 52/70] review Annex Settings and Options --- docs/4_annex_settings_and_options/index.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/docs/4_annex_settings_and_options/index.md b/docs/4_annex_settings_and_options/index.md index 78e1d788..24f0aad4 100644 --- a/docs/4_annex_settings_and_options/index.md +++ b/docs/4_annex_settings_and_options/index.md @@ -6,17 +6,14 @@ The content is organized in the following tables: - **luser*: list of variables which are generally defined by the users. - **lfbinding**: list of model variables. - **initial variables*: list of variables required for model initialization (cold and warm start of both prerun and run) -- ** -##**Table:** *LISFLOOD Settings: lfoptions.* +## **Table:** *LISFLOOD Settings: lfoptions.* The table below presents the ist of available switches to activate optional modules and optional outputs (time series and map formats). For each option, 1 = ON; 0 = OFF. Deault staus is 0 = OFF, unless otherwise indicated in the table. | section (XML) | module | KEY | Type | I/O | Description | |:------------------------|:-------------------------------------------|:----------------------------------------|:--------------------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| --------------- | ------------------------------------ | --------------------------------- | --------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | lfoptions | SETTINGS | TemperatureInKelvin | switch (1 or 0) | | Use temperature data in C (=0) or in K (=1) | | lfoptions | SETTINGS | gridSizeUserDefined | switch (1 or 0) | | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | | lfoptions | INFLOW | inflow | switch (1 or 0) | | Use inflow hydrographs | @@ -114,8 +111,6 @@ The table below presents the ist of available switches to activate optional modu | section (XML) | module | KEY | Type | I/O | Description | |:------------------------|:-------------------------------------------|:-------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| --------------- | ------------------------------------ | --------------------------------- | --------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | lfuser | SETTINGS | PathRoot | path | input | Root directory | | lfuser | SETTINGS | MaskMap | map | input | Computation area for Lisflood model | | lfuser | SETTINGS | Gauges | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) or lat lon (lat2 lon2 ...) | @@ -278,8 +273,6 @@ The table below presents the ist of available switches to activate optional modu | section (XML) | module | KEY | settings | Type | I/O | Description | |:------------------------|:---------------------------------------------------------------|:-------------------------------------------|:------------------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :-------------------- | :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| --------------- | ------------------------------------ | --------------------------------- | --------------- | --------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | lfbinding | SNOW AND FROST | Afrost | $(Afrost) | value | input | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | | lfbinding | INITIAL CONDITION | AvgDis | $(PathInit)/avgdis.map | map | input initial/internal | $(PathInit)/avgdis.map CHANNEL split routing in two lines Average discharge map [m3/s] | | lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | AvWaterRateThreshold | $(AvWaterRateThreshold) | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | @@ -536,8 +529,6 @@ The table below presents the ist of available switches to activate optional modu | section (XML) | module | KEY | In settings xml | Type | Cold Start: prerun and run | Warm Start: preun | Warm Start: run | Description | |:------------------------|:-------------------------------------------|:----------------------------------------|:----------------------------------------------|:-----------------------------|:---------------------------------------------------------------|:---------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| :-------------------- | :--------------------------------------- | :------------------------------------ | :-------------------- | :--------------------------- | :--------------------------- | :--------------------------- | :--------------------------- | :--------------------------- | -| --------------- | ------------------------------------ | --------------------------------- | --------------- | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | | lfuser | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | -9999 | ch2cro.end.nc | ch2cro.end.nc | initial channel crosssection for 2nd routing channel -9999: use 0 | | lfuser | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | 0 | cumf.end.nc | cumf.end.nc | cumulative interception forest [mm] | | lfuser | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | 0 | cum.end.nc | cum.end.nc | cumulative interception [mm] | From eac3e39b137fb7cbc9468485ea136a1b191e10a9 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 13 May 2026 19:10:40 +0200 Subject: [PATCH 53/70] review Annex Settings and Options --- docs/4_annex_settings_and_options/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/4_annex_settings_and_options/index.md b/docs/4_annex_settings_and_options/index.md index 24f0aad4..6785e7c9 100644 --- a/docs/4_annex_settings_and_options/index.md +++ b/docs/4_annex_settings_and_options/index.md @@ -2,13 +2,13 @@ This annex presents a nearly comprehensive list of setting options, inputs, and The content is organized in the following tables: -- **lfoptions**: list of available switches to activate optional modules and optional outputs (time series and map formats) +- [**lfoptions**](../4_annex_settings_and_options/index.md#table-lisflood-settings-lfoptions): list of available switches to activate optional modules and optional outputs (time series and map formats) - **luser*: list of variables which are generally defined by the users. - **lfbinding**: list of model variables. - **initial variables*: list of variables required for model initialization (cold and warm start of both prerun and run) -## **Table:** *LISFLOOD Settings: lfoptions.* +## **Table:** *lfoptions section in OS LISFLOOD settings xml* The table below presents the ist of available switches to activate optional modules and optional outputs (time series and map formats). For each option, 1 = ON; 0 = OFF. Deault staus is 0 = OFF, unless otherwise indicated in the table. @@ -106,7 +106,7 @@ The table below presents the ist of available switches to activate optional modu -##**Table:** *LISFLOOD Settings: lfuser.* +## **Table:** *lfuser in OS LISFLOOD settings xml* | section (XML) | module | KEY | Type | I/O | Description | @@ -269,7 +269,7 @@ The table below presents the ist of available switches to activate optional modu | lfuser | EVAPORATION FROM OPEN WATER | maxNoEva | 10 | value | input | -##**Table:** *LISFLOOD Settings: lfbinding.* +## **Table:** *lfbinging section in OS LISFLOOD settings xml* | section (XML) | module | KEY | settings | Type | I/O | Description | |:------------------------|:---------------------------------------------------------------|:-------------------------------------------|:------------------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -525,7 +525,7 @@ The table below presents the ist of available switches to activate optional modu -##**Table:** *Variables required for model initialization.* +## **Table:** *Variables required for model initialization.* | section (XML) | module | KEY | In settings xml | Type | Cold Start: prerun and run | Warm Start: preun | Warm Start: run | Description | |:------------------------|:-------------------------------------------|:----------------------------------------|:----------------------------------------------|:-----------------------------|:---------------------------------------------------------------|:---------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| From dfe74750ecb02e3f77594ba8ca2debbef60ee6aa Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 13 May 2026 19:14:24 +0200 Subject: [PATCH 54/70] review Annex Settings and Options --- docs/4_annex_settings_and_options/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/4_annex_settings_and_options/index.md b/docs/4_annex_settings_and_options/index.md index 6785e7c9..cf23383b 100644 --- a/docs/4_annex_settings_and_options/index.md +++ b/docs/4_annex_settings_and_options/index.md @@ -2,10 +2,10 @@ This annex presents a nearly comprehensive list of setting options, inputs, and The content is organized in the following tables: -- [**lfoptions**](../4_annex_settings_and_options/index.md#table-lisflood-settings-lfoptions): list of available switches to activate optional modules and optional outputs (time series and map formats) -- **luser*: list of variables which are generally defined by the users. -- **lfbinding**: list of model variables. -- **initial variables*: list of variables required for model initialization (cold and warm start of both prerun and run) +- [**lfoptions**](../4_annex_settings_and_options/index.md#table-lfoptions-section-in-os-lisflood-settings-xml): list of available switches to activate optional modules and optional outputs (time series and map formats) +- [**luser**](../4_annex_settings_and_options/index.md#table-lfuser-in-os-lisflood-settings-xml): list of variables which are generally defined by the users. +- [**lfbinding**](../4_annex_settings_and_options/index.md#table-lfbinging-section-in-os-lisflood-settings-xml): list of model variables. +- [**initial variables**](../4_annex_settings_and_options/index.md#table-variables-required-for-model-initialization): list of variables required for model initialization. The table indicates values/maps required by the cold and warm start of both prerun and run) ## **Table:** *lfoptions section in OS LISFLOOD settings xml* From 28319d2e758abebb934e274a1c63dcba2b3db008 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Wed, 13 May 2026 20:06:04 +0200 Subject: [PATCH 55/70] review Annex Settings and Options --- docs/4_annex_settings_and_options/index.md | 1099 ++++++++++---------- 1 file changed, 548 insertions(+), 551 deletions(-) diff --git a/docs/4_annex_settings_and_options/index.md b/docs/4_annex_settings_and_options/index.md index cf23383b..a141b272 100644 --- a/docs/4_annex_settings_and_options/index.md +++ b/docs/4_annex_settings_and_options/index.md @@ -12,566 +12,563 @@ The content is organized in the following tables: The table below presents the ist of available switches to activate optional modules and optional outputs (time series and map formats). For each option, 1 = ON; 0 = OFF. Deault staus is 0 = OFF, unless otherwise indicated in the table. -| section (XML) | module | KEY | Type | I/O | Description | -|:------------------------|:-------------------------------------------|:----------------------------------------|:--------------------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfoptions | SETTINGS | TemperatureInKelvin | switch (1 or 0) | | Use temperature data in C (=0) or in K (=1) | -| lfoptions | SETTINGS | gridSizeUserDefined | switch (1 or 0) | | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | -| lfoptions | INFLOW | inflow | switch (1 or 0) | | Use inflow hydrographs | -| lfoptions | SOIL | simulatePF | switch (1 or 0) | | Calculate pF values from soil moisture | -| lfoptions | LAKES | simulateLakes | switch (1 or 0) | | Simulate unregulated lakes | -| lfoptions | RESERVOIRS | simulateReservoirs | switch (1 or 0) | | Simulate reservoirs | -| lfoptions | LANDUSE CHANGE | TransientLandUseChange | switch (1 or 0) | | Activate reading of time changing land use description | -| lfoptions | WATER ABSTRACTION | TransientWaterDemandChange | switch (1 or 0) | | Activate reading of time changing water demand | -| lfoptions | WATER ABSTRACTION | useWaterDemandAveYear | switch (1 or 0) | | Use "average" year for water demand and loop it over years | -| lfoptions | TRANSMISSION LOSS | TransLoss | switch (1 or 0) | | Activate transmission loss | -| lfoptions | DOUBLE KINEMATIC WAVE | SplitRouting | switch (1 or 0) | | Activate double kinematic wave routing | -| lfoptions | MCT DIFFUSIVE WAVE | MCTRouting | switch (1 or 0) | | Activate MCT diffusive wave routing | -| lfoptions | WATER ABSTRACTION | wateruse | switch (1 or 0) | | Activate water use computation | -| lfoptions | GROUNDWATER | groundwaterSmooth | switch (1 or 0) | | Activate smoothing for groundwater | -| lfoptions | WATER ABSTRACTION | wateruseRegion | switch (1 or 0) | | Use water regions in water use module | -| lfoptions | IRRIGATION | drainedIrrigation | switch (1 or 0) | | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | -| lfoptions | IRRIGATION | riceIrrigation | switch (1 or 0) | | Activate computation for paddy rice irrigation and abstraction | -| lfoptions | EVAPO | openwaterevapo | switch (1 or 0, default = 1) | | Compute evaporation from open water | -| lfoptions | INDICATOR | indicator | switch (1 or 0) | | Activate computation of indicators (such as WEI, e-flow, etc) | -| lfoptions | SETTINGS | InitLisflood | switch (1 or 0) | | Run LISFLOOD initialization run | -| lfoptions | SETTINGS | InitLisfloodwithoutSplit | switch (1 or 0) | | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | -| lfoptions | SETTINGS | ColdStart | switch (1 or 0, default = 1) | | Run LISFLOOD Cold Start | -| lfoptions | IO | readNetcdfStack | switch (1 or 0) | | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | -| lfoptions | IO | writeNetcdfStack | switch (1 or 0) | | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | -| lfoptions | IO | writeNetcdf | switch (1 or 0) | | Write NetCDF files for END files (single netcdf) | -| lfoptions | DISCHARGE | repDischargeTs | switch (1 or 0, default = 1) rep tss | output | Report discharge time series at gauges | -| lfoptions | LOG | repMBTs | switch (1 or 0) rep tss | output | Report timeseries of absolute cumulative mass balance error | -| lfoptions | STATE | repStateSites | switch (1 or 0) rep tss | output | Report state variables at sites | -| lfoptions | STATE | repRateSites | switch (1 or 0) rep tss | output | Report state variables rates at sites | -| lfoptions | STATE | repStateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model variables, averaged over contributing area of each gauging station | -| lfoptions | STATE | repRateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model rate variables, averaged over contributing area of each gauging station | -| lfoptions | METEO | repMeteoUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of meteo input data | -| lfoptions | WATER ABSTRACTION | repwateruseGauges | switch (1 or 0) rep tss | output | Report water use ts at gauges | -| lfoptions | WATER ABSTRACTION | repwateruseSites | switch (1 or 0) rep tss | output | Report water use ts at sistes | -| lfoptions | SOIL | repPFUpsGauges | switch (1 or 0) rep tss | output | Report PF ts at gauges | -| lfoptions | SOIL | repPFSites | switch (1 or 0) rep tss | output | Report PF ts at sistes | -| lfoptions | LAKES | repsimulateLakes | switch (1 or 0) rep tss | output | Report time series of lakes | -| lfoptions | RESERVOIRS | repsimulateReservoirs | switch (1 or 0) rep tss | output | Report time series of reservoirs | -| lfoptions | LOG | repBal1 | switch (1 or 0) rep tss | output | Report water balance TS | -| lfoptions | STATE | repStateMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (as defined by "ReportSteps" variable) | -| lfoptions | STATE | repEndMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (at last time step) | -| lfoptions | METEO | repPrecipitationMaps | switch (1 or 0) rep maps | output | Report precipitation | -| lfoptions | METEO | repTavgMaps | switch (1 or 0) rep maps | output | Report average temperature maps | -| lfoptions | EVAPO | repETRefMaps | switch (1 or 0) rep maps | output | Report reference evapo-transpiration | -| lfoptions | EVAPO | repESRefMaps | switch (1 or 0) rep maps | output | Report reference soil evaporation | -| lfoptions | EVAPO | repEWRefMaps | switch (1 or 0) rep maps | output | Report reference evaporation of intercepted water | -| lfoptions | ROUTING | repChanCrossSectionMaps | switch (1 or 0) rep maps | output | Report total cross-section area for channels | -| lfoptions | INTERCEPTION | repCumInterCeptionMaps | switch (1 or 0) rep maps | output | Report cumulative interception | -| lfoptions | DISCHARGE | repDischargeMaps | switch (1 or 0) rep maps | output | Report maps of discharge (for each time step) | -| lfoptions | METEO | repDSLRMaps | switch (1 or 0) rep maps | output | Report maps with number of days since the last rainfall event | -| lfoptions | EVAPO | repESActMaps | switch (1 or 0) rep maps | output | Report actual soil evaporation | -| lfoptions | EVAPO | repEWIntMaps | switch (1 or 0) rep maps | output | Report evaporation of intercepted water | -| lfoptions | SNOW | repFrostIndexMaps | switch (1 or 0) rep maps | output | Report frost index maps | -| lfoptions | GROUNDWATER | repGwLossMaps | switch (1 or 0) rep maps | output | Report groundwater loss maps and trransmission loss maps (the later if the module TransLoss is active) | -| lfoptions | GROUNDWATER | repGwPercUZLZMaps | switch (1 or 0) rep maps | output | Report maps of percolation from upper to lower ground water zone (for each time step) | -| lfoptions | INFILTRATION | repInfiltrationMaps | switch (1 or 0) rep maps | output | Report infiltration maps | -| lfoptions | INTERCEPTION | repInterceptionMaps | switch (1 or 0) rep maps | output | Report interception maps | -| lfoptions | LEAF | repLeafDrainageMaps | switch (1 or 0) rep maps | output | Report leaf drainage maps | -| lfoptions | GROUNDWATER | repLZAvInflowMap | switch (1 or 0) rep maps | output | Report lower groundwater zone inflow maps | -| lfoptions | GROUNDWATER | repLZMaps | switch (1 or 0) rep maps | output | Report maps of lower groundwater zone storage (for each time step) | -| lfoptions | GROUNDWATER | repLZOutflowMaps | switch (1 or 0) rep maps | output | Report lower groundwater zone outflow maps | -| lfoptions | PERCOLATION | repPercolationMaps | switch (1 or 0) rep maps | output | Report percolation maps | -| lfoptions | SOIL | repPFMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture | -| lfoptions | SOIL | repPFForestMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture for forest fraction | -| lfoptions | SOIL | repPrefFlowMaps | switch (1 or 0) rep maps | output | Report preferential flow (rapid bypass soil matrix) | -| lfoptions | METEO | repRainMaps | switch (1 or 0) rep maps | output | Report rain excluding snow | -| lfoptions | GROUNDWATER | repSeepSubToGWMaps | switch (1 or 0) rep maps | output | Report flux between sub soil and GW | -| lfoptions | SNOW | repSnowCoverMaps | switch (1 or 0) rep maps | output | Report maps of snow cover (for each time step) | -| lfoptions | SNOW | repSnowMaps | switch (1 or 0) rep maps | output | Report maps of snow (for each time step) | -| lfoptions | SNOW | repSnowMeltMaps | switch (1 or 0) rep maps | output | Report maps of snowmelt (for each time step) | -| lfoptions | SURFACE | repSurfaceRunoffMaps | switch (1 or 0) rep maps | output | Report maps of surface runoff (for each time step) | -| lfoptions | TRANSPIRATION | repTaMaps | switch (1 or 0) rep maps | output | Report transpiration maps | -| lfoptions | SOIL | repThetaMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA | -| lfoptions | SOIL | repThetaForestMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA FOREST | -| lfoptions | SOIL | repThetaIrrigationMaps | switch (1 or 0) rep maps | output | Report irrigation mapsrE | -| lfoptions | SOIL | repTotalRunoffMaps | switch (1 or 0) rep maps | output | Report total runoff | -| lfoptions | GROUNDWATER | repUZMaps | switch (1 or 0) rep maps | output | Report maps of upper groundwater zone storage (for each time step) | -| lfoptions | GROUNDWATER | repUZOutflowMaps | switch (1 or 0) rep maps | output | Report maps for upper groundwater zone outflow | -| lfoptions | ROUTING | repWaterDepthMaps | switch (1 or 0) rep maps | output | Report water depth on soil surface | -| lfoptions | EVAPO | ETActMaps | switch (1 or 0) rep maps | output | Report actual evapo-transpiration | -| lfoptions | ROUTING | repFastRunoffMaps | switch (1 or 0) rep maps | output | Report fast runoff = surface + UZ | -| lfoptions | WATER STRESS | repRWS | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP | -| lfoptions | WATER STRESS | repStressDays | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP for forest | -| lfoptions | SOIL | repPF1Maps | switch (1 or 0) rep maps | output | Report PF1 maps | -| lfoptions | SOIL | repPF2Maps | switch (1 or 0) rep maps | output | Report PF2 maps | -| lfoptions | WATER ABSTRACTION | repTotalAbs | switch (1 or 0) rep maps | output | Report total water abstraction | -| lfoptions | WATER ABSTRACTION | repTotalWUse | switch (1 or 0) rep maps | output | Report total water use | -| lfoptions | INDICATOR | repWIndex | switch (1 or 0) rep maps | output | Report indexes and indicators | - +| module | KEY | Type | I/O | Description | +|:-------------------------------------------|:----------------------------------------|:--------------------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SETTINGS | TemperatureInKelvin | switch (1 or 0) | nan | Use temperature data in C (=0) or in K (=1) | +| SETTINGS | gridSizeUserDefined | switch (1 or 0) | nan | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | +| INFLOW | inflow | switch (1 or 0) | nan | Use inflow hydrographs | +| SOIL | simulatePF | switch (1 or 0) | nan | Calculate pF values from soil moisture | +| LAKES | simulateLakes | switch (1 or 0) | nan | Simulate unregulated lakes | +| RESERVOIRS | simulateReservoirs | switch (1 or 0) | nan | Simulate reservoirs | +| LANDUSE CHANGE | TransientLandUseChange | switch (1 or 0) | nan | Activate reading of time changing land use description | +| WATER ABSTRACTION | TransientWaterDemandChange | switch (1 or 0) | nan | Activate reading of time changing water demand | +| WATER ABSTRACTION | useWaterDemandAveYear | switch (1 or 0) | nan | Use "average" year for water demand and loop it over years | +| TRANSMISSION LOSS | TransLoss | switch (1 or 0) | nan | Activate transmission loss | +| DOUBLE KINEMATIC WAVE | SplitRouting | switch (1 or 0) | nan | Activate double kinematic wave routing | +| MCT DIFFUSIVE WAVE | MCTRouting | switch (1 or 0) | nan | Activate MCT diffusive wave routing | +| WATER ABSTRACTION | wateruse | switch (1 or 0) | nan | Activate water use computation | +| GROUNDWATER | groundwaterSmooth | switch (1 or 0) | nan | Activate smoothing for groundwater | +| WATER ABSTRACTION | wateruseRegion | switch (1 or 0) | nan | Use water regions in water use module | +| IRRIGATION | drainedIrrigation | switch (1 or 0) | nan | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | +| IRRIGATION | riceIrrigation | switch (1 or 0) | nan | Activate computation for paddy rice irrigation and abstraction | +| EVAPO | openwaterevapo | switch (1 or 0, default = 1) | nan | Compute evaporation from open water | +| INDICATOR | indicator | switch (1 or 0) | nan | Activate computation of indicators (such as WEI, e-flow, etc) | +| SETTINGS | InitLisflood | switch (1 or 0) | nan | Run LISFLOOD initialization run | +| SETTINGS | InitLisfloodwithoutSplit | switch (1 or 0) | nan | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | +| SETTINGS | ColdStart | switch (1 or 0, default = 1) | nan | Run LISFLOOD Cold Start | +| IO | readNetcdfStack | switch (1 or 0) | nan | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | +| IO | writeNetcdfStack | switch (1 or 0) | nan | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | +| IO | writeNetcdf | switch (1 or 0) | nan | Write NetCDF files for END files (single netcdf) | +| DISCHARGE | repDischargeTs | switch (1 or 0, default = 1) rep tss | output | Report discharge time series at gauges | +| LOG | repMBTs | switch (1 or 0) rep tss | output | Report timeseries of absolute cumulative mass balance error | +| STATE | repStateSites | switch (1 or 0) rep tss | output | Report state variables at sites | +| STATE | repRateSites | switch (1 or 0) rep tss | output | Report state variables rates at sites | +| STATE | repStateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model variables, averaged over contributing area of each gauging station | +| STATE | repRateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model rate variables, averaged over contributing area of each gauging station | +| METEO | repMeteoUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of meteo input data | +| WATER ABSTRACTION | repwateruseGauges | switch (1 or 0) rep tss | output | Report water use ts at gauges | +| WATER ABSTRACTION | repwateruseSites | switch (1 or 0) rep tss | output | Report water use ts at sistes | +| SOIL | repPFUpsGauges | switch (1 or 0) rep tss | output | Report PF ts at gauges | +| SOIL | repPFSites | switch (1 or 0) rep tss | output | Report PF ts at sistes | +| LAKES | repsimulateLakes | switch (1 or 0) rep tss | output | Report time series of lakes | +| RESERVOIRS | repsimulateReservoirs | switch (1 or 0) rep tss | output | Report time series of reservoirs | +| LOG | repBal1 | switch (1 or 0) rep tss | output | Report water balance TS | +| STATE | repStateMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (as defined by "ReportSteps" variable) | +| STATE | repEndMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (at last time step) | +| METEO | repPrecipitationMaps | switch (1 or 0) rep maps | output | Report precipitation | +| METEO | repTavgMaps | switch (1 or 0) rep maps | output | Report average temperature maps | +| EVAPO | repETRefMaps | switch (1 or 0) rep maps | output | Report reference evapo-transpiration | +| EVAPO | repESRefMaps | switch (1 or 0) rep maps | output | Report reference soil evaporation | +| EVAPO | repEWRefMaps | switch (1 or 0) rep maps | output | Report reference evaporation of intercepted water | +| ROUTING | repChanCrossSectionMaps | switch (1 or 0) rep maps | output | Report total cross-section area for channels | +| INTERCEPTION | repCumInterCeptionMaps | switch (1 or 0) rep maps | output | Report cumulative interception | +| DISCHARGE | repDischargeMaps | switch (1 or 0) rep maps | output | Report maps of discharge (for each time step) | +| METEO | repDSLRMaps | switch (1 or 0) rep maps | output | Report maps with number of days since the last rainfall event | +| EVAPO | repESActMaps | switch (1 or 0) rep maps | output | Report actual soil evaporation | +| EVAPO | repEWIntMaps | switch (1 or 0) rep maps | output | Report evaporation of intercepted water | +| SNOW | repFrostIndexMaps | switch (1 or 0) rep maps | output | Report frost index maps | +| GROUNDWATER | repGwLossMaps | switch (1 or 0) rep maps | output | Report groundwater loss maps and trransmission loss maps (the later if the module TransLoss is active) | +| GROUNDWATER | repGwPercUZLZMaps | switch (1 or 0) rep maps | output | Report maps of percolation from upper to lower ground water zone (for each time step) | +| INFILTRATION | repInfiltrationMaps | switch (1 or 0) rep maps | output | Report infiltration maps | +| INTERCEPTION | repInterceptionMaps | switch (1 or 0) rep maps | output | Report interception maps | +| LEAF | repLeafDrainageMaps | switch (1 or 0) rep maps | output | Report leaf drainage maps | +| GROUNDWATER | repLZAvInflowMap | switch (1 or 0) rep maps | output | Report lower groundwater zone inflow maps | +| GROUNDWATER | repLZMaps | switch (1 or 0) rep maps | output | Report maps of lower groundwater zone storage (for each time step) | +| GROUNDWATER | repLZOutflowMaps | switch (1 or 0) rep maps | output | Report lower groundwater zone outflow maps | +| PERCOLATION | repPercolationMaps | switch (1 or 0) rep maps | output | Report percolation maps | +| SOIL | repPFMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture | +| SOIL | repPFForestMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture for forest fraction | +| SOIL | repPrefFlowMaps | switch (1 or 0) rep maps | output | Report preferential flow (rapid bypass soil matrix) | +| METEO | repRainMaps | switch (1 or 0) rep maps | output | Report rain excluding snow | +| GROUNDWATER | repSeepSubToGWMaps | switch (1 or 0) rep maps | output | Report flux between sub soil and GW | +| SNOW | repSnowCoverMaps | switch (1 or 0) rep maps | output | Report maps of snow cover (for each time step) | +| SNOW | repSnowMaps | switch (1 or 0) rep maps | output | Report maps of snow (for each time step) | +| SNOW | repSnowMeltMaps | switch (1 or 0) rep maps | output | Report maps of snowmelt (for each time step) | +| SURFACE | repSurfaceRunoffMaps | switch (1 or 0) rep maps | output | Report maps of surface runoff (for each time step) | +| TRANSPIRATION | repTaMaps | switch (1 or 0) rep maps | output | Report transpiration maps | +| SOIL | repThetaMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA | +| SOIL | repThetaForestMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA FOREST | +| SOIL | repThetaIrrigationMaps | switch (1 or 0) rep maps | output | Report irrigation mapsrE | +| SOIL | repTotalRunoffMaps | switch (1 or 0) rep maps | output | Report total runoff | +| GROUNDWATER | repUZMaps | switch (1 or 0) rep maps | output | Report maps of upper groundwater zone storage (for each time step) | +| GROUNDWATER | repUZOutflowMaps | switch (1 or 0) rep maps | output | Report maps for upper groundwater zone outflow | +| ROUTING | repWaterDepthMaps | switch (1 or 0) rep maps | output | Report water depth on soil surface | +| EVAPO | ETActMaps | switch (1 or 0) rep maps | output | Report actual evapo-transpiration | +| ROUTING | repFastRunoffMaps | switch (1 or 0) rep maps | output | Report fast runoff = surface + UZ | +| WATER STRESS | repRWS | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP | +| WATER STRESS | repStressDays | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP for forest | +| SOIL | repPF1Maps | switch (1 or 0) rep maps | output | Report PF1 maps | +| SOIL | repPF2Maps | switch (1 or 0) rep maps | output | Report PF2 maps | +| WATER ABSTRACTION | repTotalAbs | switch (1 or 0) rep maps | output | Report total water abstraction | +| WATER ABSTRACTION | repTotalWUse | switch (1 or 0) rep maps | output | Report total water use | +| INDICATOR | repWIndex | switch (1 or 0) rep maps | output | Report indexes and indicators | ## **Table:** *lfuser in OS LISFLOOD settings xml* - -| section (XML) | module | KEY | Type | I/O | Description | -|:------------------------|:-------------------------------------------|:-------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfuser | SETTINGS | PathRoot | path | input | Root directory | -| lfuser | SETTINGS | MaskMap | map | input | Computation area for Lisflood model | -| lfuser | SETTINGS | Gauges | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) or lat lon (lat2 lon2 ...) | -| lfuser | SETTINGS | netCDFtemplate | map | input | netcdf template used to copy metadata information for writing netcdf $(PathEvapo)/$(PrefixE0) | -| lfuser | SETTINGS | CalendarDayStart | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | -| lfuser | SETTINGS | DtSec | value | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | -| lfuser | SETTINGS | DtSecChannel | value | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | -| lfuser | SETTINGS | StepStart | value/date | input | Step id number or date of the simulation start step. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | -| lfuser | SETTINGS | StepEnd | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | -| lfuser | SETTINGS | ReportSteps | value | input | Time steps at which to write model state maps. Use: #,#,# to specify single step numbers ; #..# to print all state files between one step and another one "endtime" to print state files for final step (to state file in NetCDF file format stack) | -| lfuser | SETTINGS | NumDaysSpinUp | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | -| lfuser | SETTINGS | NetCDFTimeChunks | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | -| lfuser | SETTINGS | MapsCaching | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | -| lfuser | SETTINGS | OutputMapsChunks | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | -| lfuser | SETTINGS | OutputMapsDataType | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | -| lfuser | GROUNDWATER | UpperZoneTimeConstant | value/map | input calib par | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | -| lfuser | GROUNDWATER | LowerZoneTimeConstant | value/map | input calib par | Time constant for the lower groundwater zone [days] This is the average time a water 'particle' remains in the reservoir if we had a stationary system (average inflow=average outflow) default: 100 | -| lfuser | GROUNDWATER | GwPercValue | value/map | input calib par | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | -| lfuser | GROUNDWATER | GwLoss | value/map | input calib par | Rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. A value of 0 (closed lower boundary) is recommended as a starting value; default: 0.0 | -| lfuser | GROUNDWATER | LZThreshold | value/map | input calib par | threshold value below which there is no outflow to the channel | -| lfuser | INFILTRATION | b_Xinanjiang | value/map | input calib par | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | -| lfuser | INFILTRATION | PowerPrefFlow | value/map | input calib par | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | -| lfuser | KINEMATIC WAVE | CalChanMan | value/map | input calib par | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | -| lfuser | SNOW | SnowMeltCoef | value/map | input calib par | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | -| lfuser | DOUBLE KINEMATIC WAVE | CalChanMan2 | value/map | input calib par | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | -| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | -| lfuser | MCT DIFFUSIVE WAVE | CalChanMan3 | value/map | input calib par | Multiplier [-] applied to Channel Manning's n for MCT diffusive wave routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | -| lfuser | LAKES | LakeMultiplier | value/map | input calib par | Multiplier applied to the lake parameter A | -| lfuser | RESERVOIRS | ReservoirFloodStorage | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | -| lfuser | RESERVOIRS | ReservoirFloodOutflowFactor | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | -| lfuser | TRANSMISSION LOSSES | TransSub | value/map | input calib par | Transmission loss function parameter | -| lfuser | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | -| lfuser | SETTINGS | AvWaterRateThreshold | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] . Default: 5.0 (not included in calibration) | -| lfuser | SETTINGS | PathOut | path | input | Directory where all output files are written. It must be an existing directory (if not you will get an error message). | -| lfuser | SETTINGS | PathInit | path | input | Path of the initial value maps e.g. lzavin.map (org=$(PathRoot)/outPo) It is the directory where the initial files are located, to initialize a “warm” start. It can be also the PathOut directory. | -| lfuser | SETTINGS | PathMaps | path | input | Maps path it is the directory where all input base maps are located | -| lfuser | INFLOW | PathInflow | path | input | Inflow path | -| lfuser | SETTINGS | PathParams | path | input | Calibration parameter path | -| lfuser | TABLE | PathTables | path | input | Tables path | -| lfuser | TABLE | PathMapsTables | path | input | Legacy terminology: path to folder where input maps are stored (some of these input maps used to be tables in legacy versions of the code) | -| lfuser | SOIL | PathSoilHyd | path | input | Maps instead tables for soil hydraulics path Directory where the soil hydraulic property maps are located | -| lfuser | LANDUSE | PathMapsLandUseChange | path | input | Maps for transient land use changes every 5 years | -| lfuser | LANDUSE | PathMapsLanduse | path | input | Maps for land use fractions and related land use maps | -| lfuser | WATER USE | PathWaterUse | path | input | Water use maps path | -| lfuser | METEO | PathMeteo | path | input | Meteo path Directory where all maps with meteorological input are located (rain, evapo(transpi)ration, temperature) | -| lfuser | LAI | PathLAI | path | input | Leaf Area Index maps path Directory where you Leaf Area Index maps are located | -| lfuser | SETTINGS | timestepInit | value/date | input initial | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". It is generally one step back compared to StepStart). timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfuser | SURFACE | OFDirectInitValue | value/map | input initial/internal | Initial water volume for direct fraction on catchment surface [m3] | -| lfuser | SURFACE | OFOtherInitValue | value/map | input initial/internal | Initial water volume for other fraction on catchment surface [m3] | -| lfuser | SURFACE | OFForestInitValue | value/map | input initial/internal | Initial water volume for forest fraction on catchment surface [m3] | -| lfuser | SNOW | SnowCoverAInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone A [mm] | -| lfuser | SNOW | SnowCoverBInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone B [mm] | -| lfuser | SNOW | SnowCoverCInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone C [mm] | -| lfuser | SNOW | FrostIndexInitValue | value/map | input initial/internal | initial Frost Index value [C day-1] | -| lfuser | INTERCEPTION | CumIntInitValue | value/map | input initial/internal | cumulative interception [mm] Initial interception storage | -| lfuser | GROUNDWATER | UZInitValue | value/map | input initial/internal | It is the initial storage in the upper groundwater zone [mm] , other fraction | -| lfuser | SOIL | DSLRInitValue | value/map | input initial/internal | initial number of days since the last rainfall event [days], , other fraction | -| lfuser | GROUNDWATER | LZInitValue | value/map | input initial/internal | It is the initial storage in the lower groundwater zone [mm] -9999: use steady-state storage | -| lfuser | KINEMATIC WAVE | TotalCrossSectionAreaInitValue | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull It is the initial cross-sectional area [m2] of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). | -| lfuser | SOIL | ThetaInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the supercificial soil layer. Other fraction. | -| lfuser | SOIL | ThetaInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the upper soil layer. Other fraction. | -| lfuser | SOIL | ThetaInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the lower soil layer. Other fraction. | -| lfuser | DOUBLE KINEMATIC WAVE | CrossSection2AreaInitValue | value/map | input initial/internal | initial channel cross-sectional area [m2] of the water in the river channels for 2nd routing channel -9999: use 0 | -| lfuser | DOUBLE KINEMATIC WAVE | PrevSideflowInitValue | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfuser | MCT DIFFUSIVE WAVE | PrevCmMCTInitValue | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfuser | MCT DIFFUSIVE WAVE | PrevDmMCTInitValue | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfuser | LAKES | LakeInitialLevelValue | value/map | input initial/internal | Initial lake level [m] -9999 sets initial value to steady-state level | -| lfuser | KINEMATIC WAVE | PrevDischarge | value/map | input initial/internal | initial discharge from previous run only needed for MCT diffusive routing -9999: use 0 It is the initial discharge from previous run [m3s-1] used for MCT diffusive routing. Note that PrevDischarge is the instantaneous discharge referred to the end of the time step. | -| lfuser | KINEMATIC WAVE | PrevDischargeAvg | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only -9999: use 0 It is the initial discharge from previous run [m3s-1] used for lakes, reservoirs and transmission loss Note that PrevDischargeAvg is the average discharge for the last routing sub-step. | -| lfuser | INTERCEPTION | CumIntForestInitValue | value/map | input initial/internal | cumulative interception forest [mm] | -| lfuser | GROUNDWATER | UZForestInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | -| lfuser | SOIL | DSLRForestInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | -| lfuser | SOIL | ThetaForestInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values Forest fraction | -| lfuser | SOIL | ThetaForestInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values Forest fraction | -| lfuser | SOIL | ThetaForestInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values Forest fraction | -| lfuser | INTERCEPTION | CumIntIrrigationInitValue | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfuser | GROUNDWATER | UZIrrigationInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfuser | SOIL | DSLRIrrigationInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | -| lfuser | SOIL | ThetaIrrigationInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 for irrigation -9999: use field capacity values Irrigated fraction | -| lfuser | SOIL | ThetaIrrigationInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values Irrigated fraction | -| lfuser | SOIL | ThetaIrrigationInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 for irrigation -9999: use field capacity values Irrigated fraction | -| lfuser | SOIL | CumIntSealedInitValue | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfuser | SOIL | cumSeepTopToSubBOtherEnd | map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | SOIL | cumSeepTopToSubBForestEnd | map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | SOIL | cumSeepTopToSubBIrrigatedEnd | map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | GROUNDWATER | CumQEnd | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfuser | GROUNDWATER | TimeSinceStartPrerunChunkEnd | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | -| lfuser | GROUNDWATER | LZInflowCumEnd | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfuser | METEO | PrefixPrecipitation | prefix | input forcings | prefix precipitation maps | -| lfuser | METEO | PrefixTavg | prefix | input forcings | prefix average temperature maps | -| lfuser | EVAPO | PrefixE0 | prefix | input forcings | prefix E0 (potential open water evaporation) maps | -| lfuser | EVAPO | PrefixES0 | prefix | input forcings | prefix ES0 (potential open bare-soil evaporation)maps | -| lfuser | EVAPO | PrefixET0 | prefix | input forcings | prefix ET0 (potential reference evapotranspioration) maps | -| lfuser | LAI | PrefixLAIOther | prefix | input forcings | prefix LAI (Leaf Area Index) maps | -| lfuser | LAI | PrefixLAIForest | prefix | input forcings | prefix LAI forest maps | -| lfuser | LAI | PrefixLAIIrrigation | prefix | input forcings | prefix LAI irrigation maps | -| lfuser | WATER USE | PrefixWaterUseDomestic | prefix | input forcings | prefix domestic water use maps | -| lfuser | WATER USE | PrefixWaterUseLivestock | prefix | input forcings | prefix livestock water use maps | -| lfuser | WATER USE | PrefixWaterUseEnergy | prefix | input forcings | prefix energy water use maps | -| lfuser | WATER USE | PrefixWaterUseIndustry | prefix | input forcings | prefix industry water use maps | -| lfuser | METEO | PrScaling | value | input par | Multiplier applied to potential precipitation rates. Default = 1.0, not used in calibration. | -| lfuser | EVAPO | CalEvaporation | value | input par | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | -| lfuser | LEAF DRAINAGE | LeafDrainageTimeConstant | value | input par | Time constant for water in interception store [days] . Default = 1.0 | -| lfuser | EVAPO | kdf | value | input par | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | -| lfuser | DEPRESSION STORAGE | SMaxSealed | value | input par | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] . This storage is emptied by evaporation (EW0). Default = 1.0 | -| lfuser | SNOW | SnowFactor | value | input par | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | -| lfuser | SNOW | SnowSeasonAdj | value | input par | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | -| lfuser | SNOW | TempMelt | value | input par | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | -| lfuser | SNOW | TempSnow | value | input par | It is the average temperature below which precipitation is assumed to be snow [°C] | -| lfuser | SNOW | TemperatureLapseRate | value | input par | Temperature lapse rate with altitude [deg C / m]. It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1]. Default = 0.0065 | -| lfuser | SNOW | Afrost | value | input par | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. Default = 0.97 | -| lfuser | SNOW | Kfrost | value | input par | Snow depth reduction coefficient, [cm-1]. Default = 0.57 | -| lfuser | SNOW | SnowWaterEquivalent | value | input par | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | -| lfuser | SNOW | FrostIndexThreshold | value | input par | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | -| lfuser | WATER ABSTRACTION | IrrigationEfficiency | value/map | input | Field application irrigation efficiency max 1, ~0.90 drip irrigation, ~0.75 sprinkling | -| lfuser | WATER ABSTRACTION | ConveyanceEfficiency | value/map | input | onveyance efficiency, around 0.80 for average channel | -| lfuser | WATER ABSTRACTION | IrrigationType | value | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | -| lfuser | WATER ABSTRACTION | IrrigationMult | value | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | -| lfuser | WATER ABSTRACTION | LivestockConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | -| lfuser | WATER ABSTRACTION | IndustryConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | -| lfuser | WATER ABSTRACTION | EnergyConsumptiveUseFraction | value/map | input | Consumptive Use (1-Recycling ratio) for energy water use (0-1) Source: Torcellini et al. (2003) "Consumptive Use for US Power Production" map advised by Neil Edwards, Energy Industry the UK and small French rivers the consumptive use varies between 1:2 and 1:3, so 0.33-0.50 For plants along big rivers like Rhine and Danube the 0.025 is ok EnergyConsumptiveUseFraction=0.025 | -| lfuser | WATER ABSTRACTION | DomesticConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | -| lfuser | WATER ABSTRACTION | LeakageFraction | value | input | $(PathMaps)/leakage.map Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | -| lfuser | WATER ABSTRACTION | LeakageWaterLoss | value | input | The water that is lost from leakage (lost) (0-1) | -| lfuser | WATER ABSTRACTION | LeakageReductionFraction | value | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | -| lfuser | WATER ABSTRACTION | WaterSavingFraction | value | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | -| lfuser | CALC INDICATOR | Population | map | input | Population per pixel | -| lfuser | CALC INDICATOR | PopulationMaps | map | input | Population map for TransientLandUseChange | -| lfuser | CALC INDICATOR | LandUseMask | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | -| lfuser | WATER ABSTRACTION | WaterUseMaps | map | output | path and prefix of the reported water use m3 s-1 as a result of demand and availability | -| lfuser | WATER ABSTRACTION | WaterUseTS | tss | output | Time series of upstream water use at gauging stations | -| lfuser | WATER ABSTRACTION | StepsWaterUseTS | tss | output | number of loops needed for water use routine | -| lfuser | WATER ABSTRACTION | maxNoWateruse | value | input | maximum number of loops for calculating the use of water | -| lfuser | WATER ABSTRACTION | WUsePercRemain | value | input | percentage of water that must remain the channel (after water abstraction) | -| lfuser | WATER ABSTRACTION / CALC INDICATOR | WUseRegion | map | input | area from which surface water is extracted | -| lfuser | GROUNDWATER | LZSmoothRange | value | input | length of the window used to smooth the LZ zone [number of cell length] It works ONLY if wateruse=1 | -| lfuser | GROUNDWATER | GroundwaterBodies | map | input | map of aquifers (0/1), used to smoothen LZ near extraction areas | -| lfuser | LAKES | LakeMask | map | input | Mask with Lakes from GLWD database | -| lfuser | TRANSMISSION | TransPower1 | value | input par | Transmission loss function parameter. Default = 2.0 | -| lfuser | TRANSMISSION | TransArea | value | input par | downstream area taking into account for transmission loss | -| lfuser | TRANSMISSION / RESERVOIR | UpAreaTrans | map | inpput | upstream area for transmission loss and computation of K coeff in reservoirs module | -| lfuser | KINEMATIC WAVE | beta | value | input par | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | -| lfuser | KINEMATIC WAVE | OFDepRef | value | input par | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | -| lfuser | KINEMATIC WAVE | GradMin | value | input par | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | -| lfuser | KINEMATIC WAVE | ChanGradMin | value | input par | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | -| lfuser | MCT DIFFUSIVE WAVE | ChannelsMCT | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | -| lfuser | MCT DIFFUSIVE WAVE | ChanGradMaxMCT | value | input par | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) [m m-1] | -| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value | input par | PBchange Multiplier applied to average Q to split into a second line of routing | -| lfuser | SOIL | CourantCrit | value | input par | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | -| lfuser | RESERVOIRS | DtSecReservoirs | value | input | Sub time step used for reservoir simulation [s]. Within the model, the smallest out of DtSecReservoirs and DtSec is used. | -| lfuser | RESERVOIRS | ReservoirInitialFillValue | value/map | input initial/internal | Initial reservoir fill fraction -9999 sets initial fill to normal storage limit if you're not using the reservoir option, enter some bogus value | -| lfuser | LAKES | TabLakeAvNetInflowEstimate | table | input | Estimate of average net inflow into lake (=inflow - evaporation) [cu m / s] Used to calculated steady-state lake level in case LakeInitialLevelValue is set to -9999 | -| lfuser | INFLOW | InflowPoints | map | input forcings | OPTIONAL: nominal map with locations of (measured) inflow hydrographs [cu m / s] | -| lfuser | INFLOW | QInTS | tss | input forcings | OPTIONAL: observed or simulated input hydrographs as time series [cu m / s] Note that identifiers in time series correspond to InflowPoints map (also optional) | -| lfuser | SOIL | HeadMax | value | input | Maximum capillary head [cm]. This value is used if Theta equals residual soil moisture content (value of HeadMax is arbitrary). Only needed for pF computation, otherwise doesn't influence model results at all) | -| lfuser | EVAPORATION FROM OPEN WATER | maxNoEva | 10 | value | input | +| module | KEY | Type | I/O | Description | +|:-------------------------------------------|:-------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SETTINGS | PathRoot | path | input | Root directory | +| SETTINGS | MaskMap | map | input | Computation area for Lisflood model | +| SETTINGS | Gauges | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) or lat lon (lat2 lon2 ...) | +| SETTINGS | netCDFtemplate | map | input | netcdf template used to copy metadata information for writing netcdf $(PathEvapo)/$(PrefixE0) | +| SETTINGS | CalendarDayStart | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | +| SETTINGS | DtSec | value | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | +| SETTINGS | DtSecChannel | value | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | +| SETTINGS | StepStart | value/date | input | Step id number or date of the simulation start step. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | +| SETTINGS | StepEnd | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | +| SETTINGS | ReportSteps | value | input | Time steps at which to write model state maps. Use: #,#,# to specify single step numbers ; #..# to print all state files between one step and another one "endtime" to print state files for final step (to state file in NetCDF file format stack) | +| SETTINGS | NumDaysSpinUp | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | +| SETTINGS | NetCDFTimeChunks | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | +| SETTINGS | MapsCaching | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | +| SETTINGS | OutputMapsChunks | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | +| SETTINGS | OutputMapsDataType | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | +| GROUNDWATER | UpperZoneTimeConstant | value/map | input calib par | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | +| GROUNDWATER | LowerZoneTimeConstant | value/map | input calib par | Time constant for the lower groundwater zone [days] This is the average time a water 'particle' remains in the reservoir if we had a stationary system (average inflow=average outflow) default: 100 | +| GROUNDWATER | GwPercValue | value/map | input calib par | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | +| GROUNDWATER | GwLoss | value/map | input calib par | Rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. A value of 0 (closed lower boundary) is recommended as a starting value; default: 0.0 | +| GROUNDWATER | LZThreshold | value/map | input calib par | threshold value below which there is no outflow to the channel | +| INFILTRATION | b_Xinanjiang | value/map | input calib par | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | +| INFILTRATION | PowerPrefFlow | value/map | input calib par | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | +| KINEMATIC WAVE | CalChanMan | value/map | input calib par | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | +| SNOW | SnowMeltCoef | value/map | input calib par | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | +| DOUBLE KINEMATIC WAVE | CalChanMan2 | value/map | input calib par | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | +| DOUBLE KINEMATIC WAVE | QSplitMult | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | +| MCT DIFFUSIVE WAVE | CalChanMan3 | value/map | input calib par | Multiplier [-] applied to Channel Manning's n for MCT diffusive wave routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | +| LAKES | LakeMultiplier | value/map | input calib par | Multiplier applied to the lake parameter A | +| RESERVOIRS | ReservoirFloodStorage | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | +| RESERVOIRS | ReservoirFloodOutflowFactor | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | +| TRANSMISSION LOSSES | TransSub | value/map | input calib par | Transmission loss function parameter | +| ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | +| SETTINGS | AvWaterRateThreshold | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] . Default: 5.0 (not included in calibration) | +| SETTINGS | PathOut | path | input | Directory where all output files are written. It must be an existing directory (if not you will get an error message). | +| SETTINGS | PathInit | path | input | Path of the initial value maps e.g. lzavin.map (org=$(PathRoot)/outPo) It is the directory where the initial files are located, to initialize a “warm” start. It can be also the PathOut directory. | +| SETTINGS | PathMaps | path | input | Maps path it is the directory where all input base maps are located | +| INFLOW | PathInflow | path | input | Inflow path | +| SETTINGS | PathParams | path | input | Calibration parameter path | +| TABLE | PathTables | path | input | Tables path | +| TABLE | PathMapsTables | path | input | Legacy terminology: path to folder where input maps are stored (some of these input maps used to be tables in legacy versions of the code) | +| SOIL | PathSoilHyd | path | input | Maps instead tables for soil hydraulics path Directory where the soil hydraulic property maps are located | +| LANDUSE | PathMapsLandUseChange | path | input | Maps for transient land use changes every 5 years | +| LANDUSE | PathMapsLanduse | path | input | Maps for land use fractions and related land use maps | +| WATER USE | PathWaterUse | path | input | Water use maps path | +| METEO | PathMeteo | path | input | Meteo path Directory where all maps with meteorological input are located (rain, evapo(transpi)ration, temperature) | +| LAI | PathLAI | path | input | Leaf Area Index maps path Directory where you Leaf Area Index maps are located | +| SETTINGS | timestepInit | value/date | input initial | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". It is generally one step back compared to StepStart). timestepInit is ignored if netCDF file is a single netCDF file.. | +| SURFACE | OFDirectInitValue | value/map | input initial/internal | Initial water volume for direct fraction on catchment surface [m3] | +| SURFACE | OFOtherInitValue | value/map | input initial/internal | Initial water volume for other fraction on catchment surface [m3] | +| SURFACE | OFForestInitValue | value/map | input initial/internal | Initial water volume for forest fraction on catchment surface [m3] | +| SNOW | SnowCoverAInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone A [mm] | +| SNOW | SnowCoverBInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone B [mm] | +| SNOW | SnowCoverCInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone C [mm] | +| SNOW | FrostIndexInitValue | value/map | input initial/internal | initial Frost Index value [C day-1] | +| INTERCEPTION | CumIntInitValue | value/map | input initial/internal | cumulative interception [mm] Initial interception storage | +| GROUNDWATER | UZInitValue | value/map | input initial/internal | It is the initial storage in the upper groundwater zone [mm] , other fraction | +| SOIL | DSLRInitValue | value/map | input initial/internal | initial number of days since the last rainfall event [days], , other fraction | +| GROUNDWATER | LZInitValue | value/map | input initial/internal | It is the initial storage in the lower groundwater zone [mm] -9999: use steady-state storage | +| KINEMATIC WAVE | TotalCrossSectionAreaInitValue | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull It is the initial cross-sectional area [m2] of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). | +| SOIL | ThetaInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the supercificial soil layer. Other fraction. | +| SOIL | ThetaInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the upper soil layer. Other fraction. | +| SOIL | ThetaInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the lower soil layer. Other fraction. | +| DOUBLE KINEMATIC WAVE | CrossSection2AreaInitValue | value/map | input initial/internal | initial channel cross-sectional area [m2] of the water in the river channels for 2nd routing channel -9999: use 0 | +| DOUBLE KINEMATIC WAVE | PrevSideflowInitValue | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| MCT DIFFUSIVE WAVE | PrevCmMCTInitValue | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| MCT DIFFUSIVE WAVE | PrevDmMCTInitValue | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| LAKES | LakeInitialLevelValue | value/map | input initial/internal | Initial lake level [m] -9999 sets initial value to steady-state level | +| KINEMATIC WAVE | PrevDischarge | value/map | input initial/internal | initial discharge from previous run only needed for MCT diffusive routing -9999: use 0 It is the initial discharge from previous run [m3s-1] used for MCT diffusive routing. Note that PrevDischarge is the instantaneous discharge referred to the end of the time step. | +| KINEMATIC WAVE | PrevDischargeAvg | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only -9999: use 0 It is the initial discharge from previous run [m3s-1] used for lakes, reservoirs and transmission loss Note that PrevDischargeAvg is the average discharge for the last routing sub-step. | +| INTERCEPTION | CumIntForestInitValue | value/map | input initial/internal | cumulative interception forest [mm] | +| GROUNDWATER | UZForestInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | +| SOIL | DSLRForestInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | +| SOIL | ThetaForestInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values Forest fraction | +| SOIL | ThetaForestInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values Forest fraction | +| SOIL | ThetaForestInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values Forest fraction | +| INTERCEPTION | CumIntIrrigationInitValue | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| GROUNDWATER | UZIrrigationInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | +| SOIL | DSLRIrrigationInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | +| SOIL | ThetaIrrigationInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 for irrigation -9999: use field capacity values Irrigated fraction | +| SOIL | ThetaIrrigationInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values Irrigated fraction | +| SOIL | ThetaIrrigationInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 for irrigation -9999: use field capacity values Irrigated fraction | +| SOIL | CumIntSealedInitValue | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| SOIL | cumSeepTopToSubBOtherEnd | map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| SOIL | cumSeepTopToSubBForestEnd | map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| SOIL | cumSeepTopToSubBIrrigatedEnd | map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| GROUNDWATER | CumQEnd | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| GROUNDWATER | TimeSinceStartPrerunChunkEnd | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | +| GROUNDWATER | LZInflowCumEnd | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| METEO | PrefixPrecipitation | prefix | input forcings | prefix precipitation maps | +| METEO | PrefixTavg | prefix | input forcings | prefix average temperature maps | +| EVAPO | PrefixE0 | prefix | input forcings | prefix E0 (potential open water evaporation) maps | +| EVAPO | PrefixES0 | prefix | input forcings | prefix ES0 (potential open bare-soil evaporation)maps | +| EVAPO | PrefixET0 | prefix | input forcings | prefix ET0 (potential reference evapotranspioration) maps | +| LAI | PrefixLAIOther | prefix | input forcings | prefix LAI (Leaf Area Index) maps | +| LAI | PrefixLAIForest | prefix | input forcings | prefix LAI forest maps | +| LAI | PrefixLAIIrrigation | prefix | input forcings | prefix LAI irrigation maps | +| WATER USE | PrefixWaterUseDomestic | prefix | input forcings | prefix domestic water use maps | +| WATER USE | PrefixWaterUseLivestock | prefix | input forcings | prefix livestock water use maps | +| WATER USE | PrefixWaterUseEnergy | prefix | input forcings | prefix energy water use maps | +| WATER USE | PrefixWaterUseIndustry | prefix | input forcings | prefix industry water use maps | +| METEO | PrScaling | value | input par | Multiplier applied to potential precipitation rates. Default = 1.0, not used in calibration. | +| EVAPO | CalEvaporation | value | input par | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | +| LEAF DRAINAGE | LeafDrainageTimeConstant | value | input par | Time constant for water in interception store [days] . Default = 1.0 | +| EVAPO | kdf | value | input par | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | +| DEPRESSION STORAGE | SMaxSealed | value | input par | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] . This storage is emptied by evaporation (EW0). Default = 1.0 | +| SNOW | SnowFactor | value | input par | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | +| SNOW | SnowSeasonAdj | value | input par | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | +| SNOW | TempMelt | value | input par | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | +| SNOW | TempSnow | value | input par | It is the average temperature below which precipitation is assumed to be snow [°C] | +| SNOW | TemperatureLapseRate | value | input par | Temperature lapse rate with altitude [deg C / m]. It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1]. Default = 0.0065 | +| SNOW | Afrost | value | input par | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. Default = 0.97 | +| SNOW | Kfrost | value | input par | Snow depth reduction coefficient, [cm-1]. Default = 0.57 | +| SNOW | SnowWaterEquivalent | value | input par | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | +| SNOW | FrostIndexThreshold | value | input par | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | +| WATER ABSTRACTION | IrrigationEfficiency | value/map | input | Field application irrigation efficiency max 1, ~0.90 drip irrigation, ~0.75 sprinkling | +| WATER ABSTRACTION | ConveyanceEfficiency | value/map | input | onveyance efficiency, around 0.80 for average channel | +| WATER ABSTRACTION | IrrigationType | value | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | +| WATER ABSTRACTION | IrrigationMult | value | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | +| WATER ABSTRACTION | LivestockConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | +| WATER ABSTRACTION | IndustryConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | +| WATER ABSTRACTION | EnergyConsumptiveUseFraction | value/map | input | Consumptive Use (1-Recycling ratio) for energy water use (0-1) Source: Torcellini et al. (2003) "Consumptive Use for US Power Production" map advised by Neil Edwards, Energy Industry the UK and small French rivers the consumptive use varies between 1:2 and 1:3, so 0.33-0.50 For plants along big rivers like Rhine and Danube the 0.025 is ok EnergyConsumptiveUseFraction=0.025 | +| WATER ABSTRACTION | DomesticConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | +| WATER ABSTRACTION | LeakageFraction | value | input | $(PathMaps)/leakage.map Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | +| WATER ABSTRACTION | LeakageWaterLoss | value | input | The water that is lost from leakage (lost) (0-1) | +| WATER ABSTRACTION | LeakageReductionFraction | value | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | +| WATER ABSTRACTION | WaterSavingFraction | value | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | +| CALC INDICATOR | Population | map | input | Population per pixel | +| CALC INDICATOR | PopulationMaps | map | input | Population map for TransientLandUseChange | +| CALC INDICATOR | LandUseMask | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | +| WATER ABSTRACTION | WaterUseMaps | map | output | path and prefix of the reported water use m3 s-1 as a result of demand and availability | +| WATER ABSTRACTION | WaterUseTS | tss | output | Time series of upstream water use at gauging stations | +| WATER ABSTRACTION | StepsWaterUseTS | tss | output | number of loops needed for water use routine | +| WATER ABSTRACTION | maxNoWateruse | value | input | maximum number of loops for calculating the use of water | +| WATER ABSTRACTION | WUsePercRemain | value | input | percentage of water that must remain the channel (after water abstraction) | +| WATER ABSTRACTION / CALC INDICATOR | WUseRegion | map | input | area from which surface water is extracted | +| GROUNDWATER | LZSmoothRange | value | input | length of the window used to smooth the LZ zone [number of cell length] It works ONLY if wateruse=1 | +| GROUNDWATER | GroundwaterBodies | map | input | map of aquifers (0/1), used to smoothen LZ near extraction areas | +| LAKES | LakeMask | map | input | Mask with Lakes from GLWD database | +| TRANSMISSION | TransPower1 | value | input par | Transmission loss function parameter. Default = 2.0 | +| TRANSMISSION | TransArea | value | input par | downstream area taking into account for transmission loss | +| TRANSMISSION / RESERVOIR | UpAreaTrans | map | inpput | upstream area for transmission loss and computation of K coeff in reservoirs module | +| KINEMATIC WAVE | beta | value | input par | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | +| KINEMATIC WAVE | OFDepRef | value | input par | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | +| KINEMATIC WAVE | GradMin | value | input par | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | +| KINEMATIC WAVE | ChanGradMin | value | input par | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | +| MCT DIFFUSIVE WAVE | ChannelsMCT | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | +| MCT DIFFUSIVE WAVE | ChanGradMaxMCT | value | input par | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) [m m-1] | +| DOUBLE KINEMATIC WAVE | QSplitMult | value | input par | PBchange Multiplier applied to average Q to split into a second line of routing | +| SOIL | CourantCrit | value | input par | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | +| RESERVOIRS | DtSecReservoirs | value | input | Sub time step used for reservoir simulation [s]. Within the model, the smallest out of DtSecReservoirs and DtSec is used. | +| RESERVOIRS | ReservoirInitialFillValue | value/map | input initial/internal | Initial reservoir fill fraction -9999 sets initial fill to normal storage limit if you're not using the reservoir option, enter some bogus value | +| LAKES | TabLakeAvNetInflowEstimate | table | input | Estimate of average net inflow into lake (=inflow - evaporation) [cu m / s] Used to calculated steady-state lake level in case LakeInitialLevelValue is set to -9999 | +| INFLOW | InflowPoints | map | input forcings | OPTIONAL: nominal map with locations of (measured) inflow hydrographs [cu m / s] | +| INFLOW | QInTS | tss | input forcings | OPTIONAL: observed or simulated input hydrographs as time series [cu m / s] Note that identifiers in time series correspond to InflowPoints map (also optional) | +| SOIL | HeadMax | value | input | Maximum capillary head [cm]. This value is used if Theta equals residual soil moisture content (value of HeadMax is arbitrary). Only needed for pF computation, otherwise doesn't influence model results at all) | +| EVAPORATION FROM OPEN WATER | maxNoEva | 10 | value | input | ## **Table:** *lfbinging section in OS LISFLOOD settings xml* -| section (XML) | module | KEY | settings | Type | I/O | Description | -|:------------------------|:---------------------------------------------------------------|:-------------------------------------------|:------------------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfbinding | SNOW AND FROST | Afrost | $(Afrost) | value | input | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | -| lfbinding | INITIAL CONDITION | AvgDis | $(PathInit)/avgdis.map | map | input initial/internal | $(PathInit)/avgdis.map CHANNEL split routing in two lines Average discharge map [m3/s] | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | AvWaterRateThreshold | $(AvWaterRateThreshold) | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | -| lfbinding | INFILTRATION | b_Xinanjiang | $(b_Xinanjiang) | map | input | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | -| lfbinding | ROUTING | beta | $(beta) | 0 | input | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | -| lfbinding | ROUTING | CalChanMan | $(CalChanMan) | 0 | input | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | -| lfbinding | ROUTING | CalChanMan2 | $(CalChanMan2) | value/map | input | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | -| lfbinding | ROUTING | CalChanMan3 | $(CalChanMan3) | value/map | input | Multiplier [-] applied to Channel Manning's n for MCT routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | -| lfbinding | TIMESTEP RELATED PARAMETERS | CalendarDayStart | $(CalendarDayStart) | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | CalEvaporation | $(CalEvaporation) | value | input | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChanCrossSectionEnd | $(PathOut)/chcro.end | map | output/end | Reported chan cross-section area [m2] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanCrossSectionState | $(PathOut)/chcro | map | output/state | Reported chan cross-section area [m2] | -| lbinding | ROUTING | ChanGradMaxMCT | $(ChanGradMaxMCT) | map | input | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) | -| lfbinding | ROUTING | ChanGradMin | $(ChanGradMin) | nan | input | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | -| lbinding | ROUTING | ChannelsMCT | $(ChannelsMCT) | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQAvgDtEnd | $(PathOut)/chanqavgdt.end | map | output/end | Reported average discharge on the last routing sub-step [cu m/s] ChanQAvgDt | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQAvgDtState | $(PathOut)/chanqavgdt | map | output/state | Reported average discharge the last routing sub-step [cu m/s] ChanQAvgDt | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQEnd | $(PathOut)/chanq.end | map | output/end | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQState | $(PathOut)/chanq | map | output/state | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChSideEnd | $(PathOut)/chside.end | map | output/end | Reported channel side flow | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChSideState | $(PathOut)/chside | map | output/state | Reported sideflow to channel for first line of routing [m3/s] | -| lfbinding | WATER USE MAPS AND PAR | ConveyanceEfficiency | $(ConveyanceEfficiency) | map | input | onveyance efficiency, around 0.80 for average channel | -| lfbinding | NUMERICS | CourantCrit | $(CourantCrit) | value | input | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | -| lfbinding | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | input initial/internal | initial channel crosssection for 2nd routing channel -9999: use 0 | -| lfbinding | REPORTED OUTPUT MAPS (END) | CrossSection2End | $(PathOut)/ch2cr.end | map | output/end | Cross section area for split routing [m2] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CrossSection2State | $(PathOut)/ch2cr | map | output/state | Cross section area for split routing [m2] | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionEnd | $(PathOut)/cum.end | map | output/end | Reported interception storage | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionForestEnd | $(PathOut)/cumf.end | map | output/end | Reported interception storage for forest | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionForestState | $(PathOut)/cumf | map | output/state | Reported interception storage for forest | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionIrrigationEnd | $(PathOut)/cumi.end | map | output/end | Reported interception storage for irrigation | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionIrrigationState | $(PathOut)/cumi | map | output/state | Reported interception storage | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionState | $(PathOut)/cum | map | output/state | Reported interception storage | -| lfbinding | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | input initial/internal | cumulative interception forest [mm] | -| lfbinding | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | input initial/internal | cumulative interception [mm] | -| lfbinding | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumIntSealedEnd | $(PathOut)/cseal.end | map | output/end | Reported depression storage | -| lfbinding | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumIntSealedState | $(PathOut)/cseal | map | output/state | Reported depression storage | -| lfbinding | REPORTED OUTPUT MAPS (END) | DischargeEnd | $(PathOut)/dis.end | map | output/end | Reported average discharge on the model timestep [m3/s] | -| lfbinding | REPORTED OUTPUT MAPS | DischargeMaps | $(PathOut)/dis | map | output | Reported average discharge [cu m/s] (average over model timestep) | -| lfbinding | REPORTED OUTPUT MAPS | DisMaps | $(PathOut)/q | map (missing) | output | Reported discharge [cu m/s] at the end of a timestep | -| lfbinding | WATER USE MAPS AND PARAMETERS | DomesticConsumptiveUseFraction | $(DomesticConsumptiveUseFraction) | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | -| lfbinding | INPUT WATER USE MAPS AND PAR | DomesticDemandMaps | $(PathWaterUse)/$(PrefixWaterUseDomestic) | map | input | Domestic water abstraction daily maps [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | DSLREnd | $(PathOut)/dslr.end | map | output/end | Reported days since last rain | -| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRForestEnd | $(PathOut)/dslf.end | map | output/end | Reported days since last rain for forest | -| lfbinding | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRForestState | $(PathOut)/dslf | map | output/state | Reported days since last rain for forest | -| lfbinding | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | input initial/internal | days since last rainfall | -| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRIrrigationEnd | $(PathOut)/dsli.end | map | output/end | Reported days since last rain for irrigation | -| lfbinding | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRIrrigationState | $(PathOut)/dsli | map | output/state | Reported days since last rain irrigation | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | DSLRMaps | $(PathOut)/dslr | map | output | Reported days since last rain | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRState | $(PathOut)/dslr | map | output/state | Reported days since last rain [ndays] | -| lfbinding | TIMESTEP RELATED PARAMETERS | DtSec | $(DtSec) | map | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | -| lfbinding | TIMESTEP RELATED PARAMETERS | DtSecChannel | $(DtSecChannel) | map | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | -| lfbinding | INPUT METEO AND VEG MAPS | E0Maps | $(PathMeteo)/$(PrefixE0) | map | input | daily reference evaporation (free water) [mm/day] | -| lfbinding | WATER USE MAPS AND PARAMETERS | EnergyConsumptiveUseFraction | $(EnergyConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for energy production water use (0-1) | -| lfbinding | INPUT WATER USE MAPS AND PAR | EnergyDemandMaps | $(PathWaterUse)/$(PrefixWaterUseEnergy) | map | input | Energy water abstraction daily maps [mm] | -| lfbinding | INPUT METEO AND VEG MAPS | ES0Maps | $(PathMeteo)/$(PrefixES0) | map | input | daily reference evaporation (soil) [mm/day] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ESRefMapsOut | $(PathOut)/es | map | output | Potential evaporation from bare soil surface [mm per time step] | -| lfbinding | INPUT METEO AND VEG MAPS | ET0Maps | $(PathMeteo)/$(PrefixET0) | map | input | daily reference evapotranspiration (crop) [mm/day] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ETRefMapsOut | $(PathOut)/et | map | output | Potential reference evapotranspiration [mm per time step] | -| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenMaps | $(PathOut)/evaop | map (missing) | output | Reported evaporation from open water [mm] | -| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenTS | $(PathOut)/evaopenUps.tss | tss (missing) | output | Time series of upstream water evaporation from open water at gauging stations | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EWRefMapsOut | $(PathOut)/ew | map | output | Potential evaporation from open water surface [mm per time step] | -| lfbinding | EVAPORATION FROM OPEN WATER | FracMaxWater | $(FracMaxWater) | value | input | Percentage of maximum extend of water | -| lfbinding | REPORTED OUTPUT MAPS (END) | FrostIndexEnd | $(PathOut)/frost.end | map | output/end | Reported frost index | -| lfbinding | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | input initial/internal | initial frost index value | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | FrostIndexState | $(PathOut)/frost | map | output/state | Reported frost index | -| lfbinding | SNOW AND FROST | FrostIndexThreshold | $(FrostIndexThreshold) | map | input | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | -| lfbinding | ROUTING | GradMin | $(GradMin) | 0 | input | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | -| lfbinding | GROUNDWATER RELATED PAR | GwLoss | $(GwLoss) | map | input | Maximum loss rate out of Lower response box, expressed as a fraction of lower zone outflow. Fraction [-], range 0-1 A value of 0 (closed lower boundary) is recommended as a starting value Maximum rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. default: 0.0 | -| lfbinding | GROUNDWATER RELATED PAR | GwPercValue | $(GwPercValue) | map | input | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | -| lfbinding | INPUT WATER USE MAPS AND PAR | IndustrialDemandMaps | $(PathWaterUse)/$(PrefixWaterUseIndustry) | map | input | Industry water abstraction daily maps [mm] | -| lfbinding | WATER USE MAPS AND PARAMETERS | IndustryConsumptiveUseFraction | $(IndustryConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | -| lfbinding | WATER USE MAPS AND PAR | IrrigationEfficiency | $(IrrigationEfficiency) | map | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | -| lfbinding | WATER USE MAPS AND PAR | IrrigationMult | $(IrrigationMult) | map | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | -| lfbinding | WATER USE MAPS AND PAR | IrrigationType | $(IrrigationType) | map | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | kdf | $(kdf) | value | input | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | -| lfbinding | SNOW AND FROST | Kfrost | $(Kfrost) | map | input | Snow depth reduction coefficient, [cm-1] | -| lfbinding | INPUT METEO AND VEG MAPS | LAIForestMaps | $(PathLAI)/$(PrefixLAIForest) | map | input | leaf area index forest [m2/m2] | -| lfbinding | INPUT METEO AND VEG MAPS | LAIIrrigationMaps | $(PathLAI)/$(PrefixLAIIrrigation) | map | input | leaf area index irrigation [m2/m2] | -| lfbinding | INPUT METEO AND VEG MAPS | LAIOtherMaps | $(PathLAI)/$(PrefixLAIOther) | map | input | leaf area index [m2/m2] | -| lfbinding | REPORTED OUTPUT MAPS (END) | LakeLevelEnd | $(PathOut)/lakeh.end | map | output/end | Reported lake level | -| lfbinding | EVAPORATION FROM OPEN WATER | LakeMask | $(LakeMask) | map | input | Mask with Lakes from GLWD database | -| lfbinding | REPORTED OUTPUT MAPS (END) | LakeStorageM3 | $(PathOut)/lakest | map | output | Reported lake storage | -| lfbinding | WATER USE MAPS AND PAR | LandUseMask | $(LandUseMask) | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | LeafDrainageTimeConstant | $(LeafDrainageTimeConstant) | map | input | Time constant for leaf drainage | -| lfbinding | WATER USE MAPS AND PARAMETERS | LeakageFraction | $(LeakageFraction) | map | input | Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | -| lfbinding | WATER USE MAPS AND PAR | LeakageReductionFraction | $(LeakageReductionFraction) | map | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | -| lfbinding | WATER USE MAPS AND PAR | LeakageWaterLoss | $(LeakageWaterLoss) | 0 | input | The water that is lost from leakage (lost) (0-1) | -| lfbinding | IRRIGATION AND WATER ABSTRACTION | LivestockConsumptiveUseFraction | $(LivestockConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | -| lfbinding | INPUT WATER USE MAPS AND PAR | LivestockDemandMaps | $(PathWaterUse)/$(PrefixWaterUseLivestock) | map | input | Livestock water abstraction daily maps [mm] | -| lfbinding | GROUNDWATER RELATED PAR | LowerZoneTimeConstant | $(LowerZoneTimeConstant) | map | input | Time constant for the lower groundwater zone [days] | -| lfbinding | INITIAL CONDITION | LZAvInflowMap | $(PathInit)/lzavin.map | value/map | input initial/internal | $(PathInit)/lzavin.map Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | -| lfbinding | REPORTED OUTPUT MAPS (END) | LZEnd | $(PathOut)/lz.end | map | output/end | Reported storage in lower groundwater zone response box [mm] | -| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | input initial/internal | water in lower store [mm] -9999: use steady-state storage | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | LZMaps | $(PathOut)/lz | map | output | Reported storage in lower groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | LZState | $(PathOut)/lz | map | output/state | Reported storage in lower response box [mm] | -| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropCoef | $(PathMapsTables)/cropcoef_i.map | table | input | Irrigation crop coefficient | -| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropGroupNumber | $(PathMapsTables)/cropgrpn_i.map | table | input | Irrigation crop group number | -| lfbinding | REPORTED OUTPUT MAPS | MaskDischargeMaps | $(PathOut)/dism | map (missing) | output | Reported discharge [cu m/s] but cut by a discharge mask map | -| lfbinding | SETTINGS | MaskMap | $(MaskMap) | map/value | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | -| lfbinding | EVAPORATION FROM OPEN WATER | maxNoEva | $(maxNoEva) | value | input | Maximum number of loops for calculating evaporation (distance water is taken to satisfy the need of evaporation from open water). Default = 10 | -| lfbinding | WATER USE MAPS AND PAR | maxNoWateruse | $(maxNoWateruse) | value | input | maximum number of loops for calculating the use of water (=distance to the water demand cell) | -| lfbinding | SETTINGS | netCDFtemplate | $(netCDFtemplate) | map | input | netcdf template used to copy metadata information for writing netcdf | -| lfbinding | ROUTING | OFDepRef | $(OFDepRef) | 0 | input | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | -| lfbinding | REPORTED OUTPUT MAPS (END) | OFDirectEnd | $(PathOut)/ofdir.end | map | output/end | Reported water volume for direct fraction on catchment surface | -| lfbinding | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | input initial/internal | Reported water volume for direct fraction on catchment surface [m^3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFDirectState | $(PathOut)/ofdir | map | output/state | Reported water volume for direct fraction on catchment surface [m3] | -| lfbinding | REPORTED OUTPUT MAPS (END) | OFForestEnd | $(PathOut)/offor.end | map | output/end | | -| lfbinding | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | input initial/internal | Reported water volume for other fraction on catchment surface [m^3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFForestState | $(PathOut)/offor | map | output/state | Reported water volume for forest fraction on catchment surface [m3] | -| lfbinding | REPORTED OUTPUT MAPS (END) | OFOtherEnd | $(PathOut)/ofoth.end | map | output/end | | -| lfbinding | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | input initial/internal | Reported water volume for forest fraction on catchment surface [m^3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFOtherState | $(PathOut)/ofoth | map | output/state | Reported water volume for other fraction on catchment surface [m3] | -| lfbinding | WATER USE MAPS AND PAR | Population | $(Population) | map | input | Population per pixel | -| lfbinding | WATER USE MAPS AND PAR | PopulationMaps | $(PopulationMaps) | map | input | Population map for TransientLandUseChange | -| lfbinding | INFILTRATION | PowerPrefFlow | $(PowerPrefFlow) | map | input | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | -| lfbinding | INPUT METEO AND VEG MAPS | PrecipitationMaps | $(PathMeteo)/$(PrefixPrecipitation) | map | input | precipitation [mm/day] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | PrecipitationMapsOut | $(PathOut)/pr | map | output | Precipitation [mm per time step] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTEnd | $(PathOut)/prevcm.end | map | output/end | Reported Courant number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTState | $(PathOut)/prevcm | map | output/state | Reported Courant number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | input initial/internal | initial discharge from previous run for MCT diffusive routing -9999: use 0 | -| lfbinding | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTEnd | $(PathOut)/prevdm.end | map | output/end | Reported Raynolds number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTState | $(PathOut)/prevdm | map | output/state | Reported Reynolds number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | PrScaling | $(PrScaling) | value | input | Multiplier applied to potential precipitation rates | -| lfbinding | ROUTING | QSplitMult | $(QSplitMult) | value | input | PBchange Multiplier applied to average Q to split into a second line of routing | -| lfbinding | REPORTED OUTPUT MAPS (END) | ReservoirFillEnd | $(PathOut)/rsfil.end | map | output/end | Reported reservoir filling | -| lfbinding | RICE IRRIGATION | RiceFlooding | 10 | 0 | input | water amount in mm per day 10 mm for 10 days (total 10cm water) | -| lfbinding | RICE IRRIGATION | RiceHarvestDay1 | $(PathMapsTables)/riceharvestday1.map | map | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RiceHarvestDay2 | $(PathMapsTables)/riceharvestday2.map | map | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RicePercolation | 2 | 0 | input | FAO: percolation for heavy clay soils: PERC = 2 mm/day | -| lfbinding | RICE IRRIGATION | RicePlantingDay1 | $(PathMapsTables)/riceplantingday1.map | table | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RicePlantingDay2 | $(PathMapsTables)/riceplantingday2.map | table | input | map with starting day of the year | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | SMaxSealed | $(SMaxSealed) | value | input | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] This storage is emptied by evaporation (EW0) | -| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverAEnd | $(PathOut)/scova.end | map | output/end | Reported snow cover in snow zone A [mm] | -| lfbinding | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | input initial/internal | initial snow depth in snow zone A [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverAState | $(PathOut)/scova | map | output/state | Reported snow cover in snow zone A [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverBEnd | $(PathOut)/scovb.end | map | output/end | Reported snow cover in snow zone B [mm] | -| lfbinding | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | input initial/internal | initial snow depth in snow zone B [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverBState | $(PathOut)/scovb | map | output/state | Reported snow cover in snow zone B [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverCEnd | $(PathOut)/scovc.end | map | output/end | Reported snow cover in snow zone C [mm] | -| lfbinding | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | input initial/internal | initial snow depth in snow zone C [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverCState | $(PathOut)/scovc | map | output/state | Reported snow cover in snow zone C [mm] | -| lfbinding | SNOW AND FROST | SnowFactor | $(SnowFactor) | 0 | input | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | -| lfbinding | SNOW AND FROST | SnowMeltCoef | $(SnowMeltCoef) | 0 | input | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | -| lfbinding | SNOW AND FROST | SnowSeasonAdj | $(SnowSeasonAdj) | 0 | input | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | -| lfbinding | SNOW AND FROST | SnowWaterEquivalent | $(SnowWaterEquivalent) | 0 | input | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | -| lfbinding | TIMESTEP RELATED PARAMETERS | StepEnd | $(StepEnd) | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | -| lfbinding | TIMESTEP RELATED PARAMETERS | StepStart | $(StepStart) | value/date | input | Step id number or date of the simulation start step. See code for a list of available date formats. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | -| lfbinding | WATER USE MAPS AND PAR | StepsWaterUseTS | $(StepsWaterUseTS) | tss | input | number of loops needed for water use routine | -| lfbinding | REPORTED OUTPUT MAPS | SurfaceSoilMoistureMaps | $(PathOut)/wta | map (missing) | output | Reported surface soil moisture [%] | -| lfbinding | INPUT METEO AND VEG MAPS | TavgMaps | $(PathMeteo)/$(PrefixTavg) | map | input | average daily temperature [C] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | TavgMapsOut | $(PathOut)/tav | map | output | Average DAILY temperature [degrees C] | -| lfbinding | SNOW AND FROST | TemperatureLapseRate | $(TemperatureLapseRate) | 0 | input | Temperature lapse rate with altitude [deg C / m] It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1] | -| lfbinding | SNOW AND FROST | TempMelt | $(TempMelt) | 0 | input | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | -| lfbinding | SNOW AND FROST | TempSnow | $(TempSnow) | 0 | input | It is the average temperature below which precipitation is assumed to be snow [°C] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1End | $(PathOut)/tha.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1ForestEnd | $(PathOut)/thfa.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a for forest [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1ForestState | $(PathOut)/thfa | map | output/state | theta for soil layer 1a forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1IrrigationEnd | $(PathOut)/thia.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1IrrigationState | $(PathOut)/thia | map | output/state | Reported volumetric soil moisture content for soil layer 1a for irrigation[V/V] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta1Maps | $(PathOut)/thtop | map | output | Reported volumetric soil moisture content for soil layer 1 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1State | $(PathOut)/tha | map | output/state | Reported volumetric soil moisture content for soil layer 1 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2End | $(PathOut)/thb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2ForestEnd | $(PathOut)/thfb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b for forest [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2ForestState | $(PathOut)/thfb | map | output/state | theta for soil layer 1b forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2IrrigationEnd | $(PathOut)/thib.end | map | output/end | Reported volumetric soil moisture content for soil layer 1b [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2IrrigationState | $(PathOut)/thib | map | output/state | Reported volumetric soil moisture content for both soil layer 1b for irrigation [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2State | $(PathOut)/thb | map | output/state | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3End | $(PathOut)/thc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3ForestEnd | $(PathOut)/thfc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3ForestState | $(PathOut)/thfc | map | output/state | theta for soil layer 2 forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3IrrigationEnd | $(PathOut)/thic.end | map | output/end | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3IrrigationState | $(PathOut)/thic | map | output/state | Reported volumetric soil moisture content for both soil layer 2 for irrigation [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta3Maps | $(PathOut)/thbot | map | output | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3State | $(PathOut)/thc | map | output/state | Reported volumetric soil moisture content for both soil layer 3 [V/V] | -| lfbinding | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | input initial/internal | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfbinding | REPORTED OUTPUT MAPS | TopSoilMoistureMaps | $(PathOut)/wt | map (missing) | output | Reported Topsoil moisture [%] | -| lfbinding | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotalRunoffMaps | $(PathOut)/trun | map | output | Reported total runoff [mm/∆t] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotaltoChanMaps | $(PathOut)/ttoc | map | output | Reported total runoff that enters the channel: groundwater + surface runoff [mm/∆t] | -| lfbinding | TRANSMISSION LOSS | TransArea | $(TransArea) | 0 | input | PBchange downstream area taking into account for transmission loss | -| lfbinding | TRANSMISSION LOSS | TransPower1 | $(TransPower1) | 0 | input | PBchange Transmission loss function parameter | -| lfbinding | TRANSMISSION LOSS | TransSub | $(TransSub) | 0 | input | PBchange Transmission loss function parameter | -| lfbinding | TRANSMISSION LOSS | UpAreaTrans | $(UpAreaTrans) | 0 | input | upstream area for transmission loss | -| lfbinding | GROUNDWATER RELATED PAR | UpperZoneTimeConstant | $(UpperZoneTimeConstant) | map | input | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | -| lfbinding | REPORTED OUTPUT MAPS (END) | UZEnd | $(PathOut)/uz.end | map | output/end | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | UZForestEnd | $(PathOut)/uzf.end | map | output/end | Reported storage in upper groundwaterzone response box [mm] | -| lfbinding | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZForestState | $(PathOut)/uzf | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | input initial/internal | water in upper groundwater zone [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | UZIrrigationEnd | $(PathOut)/uzi.end | map | output/end | Reported storage in upper groundwater zone response box for irrigation [mm] | -| lfbinding | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZIrrigationState | $(PathOut)/uzi | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | UZMaps | $(PathOut)/uz | map | output | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | UZOutflowMaps | $(PathOut)/quz | map | output | Reported upper groundwater zone outflow [mm/∆t] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZState | $(PathOut)/uz | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | WaterDepthEnd | $(PathOut)/wdept.end | map | output/end | Reported overlandflow water depth | -| lfbinding | OUPUT | WaterDepthInitValue | $(WaterDepthInitValue) | map | input | initial overland flow water depth [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | WaterDepthMaps | $(PathOut)/wdept | map | output | Reported water depth | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | WaterDepthState | $(PathOut)/wdept | map | output | Reported overland flow water depth | -| lfbinding | REPORTED OUTPUT MAPS | WaterLevelMaps | $(PathOut)/wl | map | output | Reported water level [m] | -| lfbinding | WATER USE MAPS AND PAR | WaterReUseFraction | $(WaterReUseFraction) | 0 | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | -| lfbinding | WATER USE MAPS AND PAR | WaterSavingFraction | $(WaterSavingFraction) | 0 | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | -| lfbinding | WATER USE MAPS AND PAR | WaterUseMaps | $(WaterUseMaps) | map | input | Reported water use m3 s-1 depending on the availability of discharge | -| lfbinding | WATER USE MAPS AND PAR | WaterUseTS | $(WaterUseTS) | tss | input | Time series of upstream water use at gauging stations | -| lfbinding | EVAPORATION FROM OPEN WATER | WFracOfDay | $(PathTables)/WFracOfDay.txt | map | input | table with days for each water use maps 1st column: range of days; 2nd column: suffix of wuse map | -| lfbinding | EVAPORATION FROM OPEN WATER | WFractionMaps | $(PathVarWaterfraction)/$(PrefixVarWaterFraction) | map | input | water use daily maps with a (in this case negative) volume of water [cu m/s] | -| lfbinding | WATER USE MAPS AND PAR | WUsePercRemain | $(WUsePercRemain) | value | input | percentage of water that must remain in a grid cell and is not withdrawn by water use e.g. 0.2 = 20 percent of discharge is not taken out | -| lfbinding | WATER USE MAPS AND PAR | WUseRegion | $(WUseRegion) | map | input | water use region | -| lfbinding | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | $(ChanBottomWMult) $(ChanDepthMult) $(ChanSMult) | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | -| lfbinding | INITIAL CONDITION | CumQEnd | $(CumQEnd) | map | output | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | CumQInit | $(CumQInit) | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestEnd | $(cumSeepTopToSubBForestEnd) | map | output | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationEnd | $(cumSeepTopToSubBIrrigationEnd) | map | output | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherEnd | $(cumSeepTopToSubBOtherEnd) | map | output | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | LZInflowCumEnd | $(LZInflowCumEnd) | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | value/map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfbinding | SETTINGS | MapsCaching | $(MapsCaching) | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | -| lfbinding | SETTINGS | NetCDFTimeChunks | $(NetCDFTimeChunks) | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | -| lfbinding | SETTINGS | NumDaysSpinUp | $(NumDaysSpinUp) | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | -| lfbinding | SETTINGS | OutputMapsChunks | $(OutputMapsChunks) | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | -| lfbinding | SETTINGS | OutputMapsDataType | $(OutputMapsDataType) | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | -| lfbinding | DOUBLE KINEMATIC WAVE | QSplitMult | $(QSplitMult) | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | -| lfbinding | RESERVOIRS | ReservoirFloodOutflowFactor | $(ReservoirFloodOutflowFactor) | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | -| lfbinding | RESERVOIRS | ReservoirFloodStorage | $(ReservoirFloodStorage) | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | -| lfbinding | SOIL INIT | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | -| lfbinding | SOIL INIT | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | -| lfbinding | SOIL INIT | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkEnd | $(TimeSinceStartPrerunChunkEnd) | map | output | Cumulative discharge. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | - - +| module | KEY | Type | I/O | Description | +|:---------------------------------------------------------------|:-------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNOW AND FROST | Afrost | value | input | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | +| INITIAL CONDITION | AvgDis | map | input initial/internal | $(PathInit)/avgdis.map CHANNEL split routing in two lines Average discharge map [m3/s] | +| EVAPO(TRANSPI)RATION AND INTERCEPTION | AvWaterRateThreshold | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | +| INFILTRATION | b_Xinanjiang | map | input | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | +| ROUTING | beta | value | input | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | +| ROUTING | CalChanMan | value/map | input | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | +| ROUTING | CalChanMan2 | value/map | input | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | +| ROUTING | CalChanMan3 | value/map | input | Multiplier [-] applied to Channel Manning's n for MCT routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | +| TIMESTEP RELATED PARAMETERS | CalendarDayStart | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | +| EVAPO(TRANSPI)RATION AND INTERCEPTION | CalEvaporation | value | input | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | +| REPORTED OUTPUT MAPS (END) | ChanCrossSectionEnd | map | output/end | Reported chan cross-section area [m2] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanCrossSectionState | map | output/state | Reported chan cross-section area [m2] | +| ROUTING | ChanGradMaxMCT | map | input | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) | +| ROUTING | ChanGradMin | nan | input | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | +| ROUTING | ChannelsMCT | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | +| REPORTED OUTPUT MAPS (END) | ChanQAvgDtEnd | map | output/end | Reported average discharge on the last routing sub-step [cu m/s] ChanQAvgDt | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQAvgDtState | map | output/state | Reported average discharge the last routing sub-step [cu m/s] ChanQAvgDt | +| REPORTED OUTPUT MAPS (END) | ChanQEnd | map | output/end | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQState | map | output/state | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | +| REPORTED OUTPUT MAPS (END) | ChSideEnd | map | output/end | Reported channel side flow | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChSideState | map | output/state | Reported sideflow to channel for first line of routing [m3/s] | +| WATER USE MAPS AND PAR | ConveyanceEfficiency | map | input | onveyance efficiency, around 0.80 for average channel | +| NUMERICS | CourantCrit | value | input | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | +| INITIAL CONDITION | CrossSection2AreaInitValue | value/map | input initial/internal | initial channel crosssection for 2nd routing channel -9999: use 0 | +| REPORTED OUTPUT MAPS (END) | CrossSection2End | map | output/end | Cross section area for split routing [m2] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CrossSection2State | map | output/state | Cross section area for split routing [m2] | +| REPORTED OUTPUT MAPS (END) | CumInterceptionEnd | map | output/end | Reported interception storage | +| REPORTED OUTPUT MAPS (END) | CumInterceptionForestEnd | map | output/end | Reported interception storage for forest | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionForestState | map | output/state | Reported interception storage for forest | +| REPORTED OUTPUT MAPS (END) | CumInterceptionIrrigationEnd | map | output/end | Reported interception storage for irrigation | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionIrrigationState | map | output/state | Reported interception storage | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionState | map | output/state | Reported interception storage | +| INITIAL CONDITION | CumIntForestInitValue | value/map | input initial/internal | cumulative interception forest [mm] | +| INITIAL CONDITION | CumIntInitValue | value/map | input initial/internal | cumulative interception [mm] | +| INITIAL CONDITION | CumIntIrrigationInitValue | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| REPORTED OUTPUT MAPS (END) | CumIntSealedEnd | map | output/end | Reported depression storage | +| INITIAL CONDITION | CumIntSealedInitValue | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumIntSealedState | map | output/state | Reported depression storage | +| REPORTED OUTPUT MAPS (END) | DischargeEnd | map | output/end | Reported average discharge on the model timestep [m3/s] | +| REPORTED OUTPUT MAPS | DischargeMaps | map | output | Reported average discharge [cu m/s] (average over model timestep) | +| REPORTED OUTPUT MAPS | DisMaps | map (missing) | output | Reported discharge [cu m/s] at the end of a timestep | +| WATER USE MAPS AND PARAMETERS | DomesticConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | +| INPUT WATER USE MAPS AND PAR | DomesticDemandMaps | map | input | Domestic water abstraction daily maps [mm] | +| REPORTED OUTPUT MAPS (END) | DSLREnd | map | output/end | Reported days since last rain | +| REPORTED OUTPUT MAPS (END) | DSLRForestEnd | map | output/end | Reported days since last rain for forest | +| INITIAL CONDITION | DSLRForestInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRForestState | map | output/state | Reported days since last rain for forest | +| INITIAL CONDITION | DSLRInitValue | value/map | input initial/internal | days since last rainfall | +| REPORTED OUTPUT MAPS (END) | DSLRIrrigationEnd | map | output/end | Reported days since last rain for irrigation | +| INITIAL CONDITION | DSLRIrrigationInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRIrrigationState | map | output/state | Reported days since last rain irrigation | +| REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | DSLRMaps | map | output | Reported days since last rain | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRState | map | output/state | Reported days since last rain [ndays] | +| TIMESTEP RELATED PARAMETERS | DtSec | map | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | +| TIMESTEP RELATED PARAMETERS | DtSecChannel | map | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | +| INPUT METEO AND VEG MAPS | E0Maps | map | input | daily reference evaporation (free water) [mm/day] | +| WATER USE MAPS AND PARAMETERS | EnergyConsumptiveUseFraction | map | input | Consumptive Use (1-Recycling ratio) for energy production water use (0-1) | +| INPUT WATER USE MAPS AND PAR | EnergyDemandMaps | map | input | Energy water abstraction daily maps [mm] | +| INPUT METEO AND VEG MAPS | ES0Maps | map | input | daily reference evaporation (soil) [mm/day] | +| REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ESRefMapsOut | map | output | Potential evaporation from bare soil surface [mm per time step] | +| INPUT METEO AND VEG MAPS | ET0Maps | map | input | daily reference evapotranspiration (crop) [mm/day] | +| REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ETRefMapsOut | map | output | Potential reference evapotranspiration [mm per time step] | +| EVAPORATION FROM OPEN WATER | EvaOpenMaps | map (missing) | output | Reported evaporation from open water [mm] | +| EVAPORATION FROM OPEN WATER | EvaOpenTS | tss (missing) | output | Time series of upstream water evaporation from open water at gauging stations | +| REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EWRefMapsOut | map | output | Potential evaporation from open water surface [mm per time step] | +| EVAPORATION FROM OPEN WATER | FracMaxWater | value | input | Percentage of maximum extend of water | +| REPORTED OUTPUT MAPS (END) | FrostIndexEnd | map | output/end | Reported frost index | +| INITIAL CONDITION | FrostIndexInitValue | value/map | input initial/internal | initial frost index value | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | FrostIndexState | map | output/state | Reported frost index | +| SNOW AND FROST | FrostIndexThreshold | map | input | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | +| ROUTING | GradMin | 0 | input | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | +| GROUNDWATER RELATED PAR | GwLoss | map | input | Maximum loss rate out of Lower response box, expressed as a fraction of lower zone outflow. Fraction [-], range 0-1 A value of 0 (closed lower boundary) is recommended as a starting value Maximum rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. default: 0.0 | +| GROUNDWATER RELATED PAR | GwPercValue | map | input | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | +| INPUT WATER USE MAPS AND PAR | IndustrialDemandMaps | map | input | Industry water abstraction daily maps [mm] | +| WATER USE MAPS AND PARAMETERS | IndustryConsumptiveUseFraction | map | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | +| WATER USE MAPS AND PAR | IrrigationEfficiency | map | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | +| WATER USE MAPS AND PAR | IrrigationMult | map | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | +| WATER USE MAPS AND PAR | IrrigationType | map | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | +| EVAPO(TRANSPI)RATION AND INTERCEPTION | kdf | value | input | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | +| SNOW AND FROST | Kfrost | map | input | Snow depth reduction coefficient, [cm-1] | +| INPUT METEO AND VEG MAPS | LAIForestMaps | map | input | leaf area index forest [m2/m2] | +| INPUT METEO AND VEG MAPS | LAIIrrigationMaps | map | input | leaf area index irrigation [m2/m2] | +| INPUT METEO AND VEG MAPS | LAIOtherMaps | map | input | leaf area index [m2/m2] | +| REPORTED OUTPUT MAPS (END) | LakeLevelEnd | map | output/end | Reported lake level | +| EVAPORATION FROM OPEN WATER | LakeMask | map | input | Mask with Lakes from GLWD database | +| REPORTED OUTPUT MAPS (END) | LakeStorageM3 | map | output | Reported lake storage | +| WATER USE MAPS AND PAR | LandUseMask | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | +| EVAPO(TRANSPI)RATION AND INTERCEPTION | LeafDrainageTimeConstant | map | input | Time constant for leaf drainage | +| WATER USE MAPS AND PARAMETERS | LeakageFraction | map | input | Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | +| WATER USE MAPS AND PAR | LeakageReductionFraction | map | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | +| WATER USE MAPS AND PAR | LeakageWaterLoss | value | input | The water that is lost from leakage (lost) (0-1) | +| IRRIGATION AND WATER ABSTRACTION | LivestockConsumptiveUseFraction | map | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | +| INPUT WATER USE MAPS AND PAR | LivestockDemandMaps | map | input | Livestock water abstraction daily maps [mm] | +| GROUNDWATER RELATED PAR | LowerZoneTimeConstant | map | input | Time constant for the lower groundwater zone [days] | +| INITIAL CONDITION | LZAvInflowMap | value/map | input initial/internal | $(PathInit)/lzavin.map Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | +| REPORTED OUTPUT MAPS (END) | LZEnd | map | output/end | Reported storage in lower groundwater zone response box [mm] | +| INITIAL CONDITION | LZInitValue | value/map | input initial/internal | water in lower store [mm] -9999: use steady-state storage | +| REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | LZMaps | map | output | Reported storage in lower groundwater zone response box [mm] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | LZState | map | output/state | Reported storage in lower response box [mm] | +| WATER USE MAPS AND PAR | MapIrrigationCropCoef | table | input | Irrigation crop coefficient | +| WATER USE MAPS AND PAR | MapIrrigationCropGroupNumber | table | input | Irrigation crop group number | +| REPORTED OUTPUT MAPS | MaskDischargeMaps | map (missing) | output | Reported discharge [cu m/s] but cut by a discharge mask map | +| SETTINGS | MaskMap | map/value | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | +| EVAPORATION FROM OPEN WATER | maxNoEva | value | input | Maximum number of loops for calculating evaporation (distance water is taken to satisfy the need of evaporation from open water). Default = 10 | +| WATER USE MAPS AND PAR | maxNoWateruse | value | input | maximum number of loops for calculating the use of water (=distance to the water demand cell) | +| SETTINGS | netCDFtemplate | map | input | netcdf template used to copy metadata information for writing netcdf | +| ROUTING | OFDepRef | 0 | input | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | +| REPORTED OUTPUT MAPS (END) | OFDirectEnd | map | output/end | Reported water volume for direct fraction on catchment surface | +| INITIAL CONDITION | OFDirectInitValue | value/map | input initial/internal | Reported water volume for direct fraction on catchment surface [m^3] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFDirectState | map | output/state | Reported water volume for direct fraction on catchment surface [m3] | +| REPORTED OUTPUT MAPS (END) | OFForestEnd | map | output/end | | +| INITIAL CONDITION | OFForestInitValue | value/map | input initial/internal | Reported water volume for other fraction on catchment surface [m^3] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFForestState | map | output/state | Reported water volume for forest fraction on catchment surface [m3] | +| REPORTED OUTPUT MAPS (END) | OFOtherEnd | map | output/end | | +| INITIAL CONDITION | OFOtherInitValue | value/map | input initial/internal | Reported water volume for forest fraction on catchment surface [m^3] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFOtherState | map | output/state | Reported water volume for other fraction on catchment surface [m3] | +| WATER USE MAPS AND PAR | Population | map | input | Population per pixel | +| WATER USE MAPS AND PAR | PopulationMaps | map | input | Population map for TransientLandUseChange | +| INFILTRATION | PowerPrefFlow | map | input | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | +| INPUT METEO AND VEG MAPS | PrecipitationMaps | map | input | precipitation [mm/day] | +| REPORTED OUTPUT MAPS (DRIVING METEO VAR) | PrecipitationMapsOut | map | output | Precipitation [mm per time step] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTEnd | map | output/end | Reported Courant number at previous step for MCT routing | +| INITIAL CONDITION | PrevCmMCTInitValue | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTState | map | output/state | Reported Courant number at previous step for MCT routing | +| INITIAL CONDITION | PrevDischarge | value/map | input initial/internal | initial discharge from previous run for MCT diffusive routing -9999: use 0 | +| INITIAL CONDITION | PrevDischargeAvg | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTEnd | map | output/end | Reported Raynolds number at previous step for MCT routing | +| INITIAL CONDITION | PrevDmMCTInitValue | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTState | map | output/state | Reported Reynolds number at previous step for MCT routing | +| INITIAL CONDITION | PrevSideflowInitValue | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| EVAPO(TRANSPI)RATION AND INTERCEPTION | PrScaling | value | input | Multiplier applied to potential precipitation rates | +| ROUTING | QSplitMult | value | input | PBchange Multiplier applied to average Q to split into a second line of routing | +| REPORTED OUTPUT MAPS (END) | ReservoirFillEnd | map | output/end | Reported reservoir filling | +| RICE IRRIGATION | RiceFlooding | value | input | water amount in mm per day 10 mm for 10 days (total 10cm water) | +| RICE IRRIGATION | RiceHarvestDay1 | map | input | map with starting day of the year | +| RICE IRRIGATION | RiceHarvestDay2 | map | input | map with starting day of the year | +| RICE IRRIGATION | RicePercolation | value | input | FAO: percolation for heavy clay soils: PERC = 2 mm/day | +| RICE IRRIGATION | RicePlantingDay1 | table | input | map with starting day of the year | +| RICE IRRIGATION | RicePlantingDay2 | table | input | map with starting day of the year | +| EVAPO(TRANSPI)RATION AND INTERCEPTION | SMaxSealed | value | input | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] This storage is emptied by evaporation (EW0) | +| REPORTED OUTPUT MAPS (END) | SnowCoverAEnd | map | output/end | Reported snow cover in snow zone A [mm] | +| INITIAL CONDITION | SnowCoverAInitValue | value/map | input initial/internal | initial snow depth in snow zone A [mm] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverAState | map | output/state | Reported snow cover in snow zone A [mm] | +| REPORTED OUTPUT MAPS (END) | SnowCoverBEnd | map | output/end | Reported snow cover in snow zone B [mm] | +| INITIAL CONDITION | SnowCoverBInitValue | value/map | input initial/internal | initial snow depth in snow zone B [mm] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverBState | map | output/state | Reported snow cover in snow zone B [mm] | +| REPORTED OUTPUT MAPS (END) | SnowCoverCEnd | map | output/end | Reported snow cover in snow zone C [mm] | +| INITIAL CONDITION | SnowCoverCInitValue | value/map | input initial/internal | initial snow depth in snow zone C [mm] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverCState | map | output/state | Reported snow cover in snow zone C [mm] | +| SNOW AND FROST | SnowFactor | value | input | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | +| SNOW AND FROST | SnowMeltCoef | value/map | input | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | +| SNOW AND FROST | SnowSeasonAdj | value | input | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | +| SNOW AND FROST | SnowWaterEquivalent | value | input | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | +| TIMESTEP RELATED PARAMETERS | StepEnd | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | +| TIMESTEP RELATED PARAMETERS | StepStart | value/date | input | Step id number or date of the simulation start step. See code for a list of available date formats. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | +| WATER USE MAPS AND PAR | StepsWaterUseTS | tss | input | number of loops needed for water use routine | +| REPORTED OUTPUT MAPS | SurfaceSoilMoistureMaps | map (missing) | output | Reported surface soil moisture [%] | +| INPUT METEO AND VEG MAPS | TavgMaps | map | input | average daily temperature [C] | +| REPORTED OUTPUT MAPS (DRIVING METEO VAR) | TavgMapsOut | map | output | Average DAILY temperature [degrees C] | +| SNOW AND FROST | TemperatureLapseRate | value | input | Temperature lapse rate with altitude [deg C / m] It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1] | +| SNOW AND FROST | TempMelt | value | input | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | +| SNOW AND FROST | TempSnow | value | input | It is the average temperature below which precipitation is assumed to be snow [°C] | +| REPORTED OUTPUT MAPS (END) | Theta1End | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | +| REPORTED OUTPUT MAPS (END) | Theta1ForestEnd | map | output/end | Reported volumetric soil moisture content for soil layer 1a for forest [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1ForestState | map | output/state | theta for soil layer 1a forest fraction | +| REPORTED OUTPUT MAPS (END) | Theta1IrrigationEnd | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1IrrigationState | map | output/state | Reported volumetric soil moisture content for soil layer 1a for irrigation[V/V] | +| REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta1Maps | map | output | Reported volumetric soil moisture content for soil layer 1 [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1State | map | output/state | Reported volumetric soil moisture content for soil layer 1 [V/V] | +| REPORTED OUTPUT MAPS (END) | Theta2End | map | output/end | Reported volumetric soil moisture content for both soil layer 1b [V/V] | +| REPORTED OUTPUT MAPS (END) | Theta2ForestEnd | map | output/end | Reported volumetric soil moisture content for both soil layer 1b for forest [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2ForestState | map | output/state | theta for soil layer 1b forest fraction | +| REPORTED OUTPUT MAPS (END) | Theta2IrrigationEnd | map | output/end | Reported volumetric soil moisture content for soil layer 1b [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2IrrigationState | map | output/state | Reported volumetric soil moisture content for both soil layer 1b for irrigation [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2State | map | output/state | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| REPORTED OUTPUT MAPS (END) | Theta3End | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| REPORTED OUTPUT MAPS (END) | Theta3ForestEnd | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3ForestState | map | output/state | theta for soil layer 2 forest fraction | +| REPORTED OUTPUT MAPS (END) | Theta3IrrigationEnd | map | output/end | Reported volumetric soil moisture content for soil layer 2 [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3IrrigationState | map | output/state | Reported volumetric soil moisture content for both soil layer 2 for irrigation [V/V] | +| REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta3Maps | map | output | Reported volumetric soil moisture content for soil layer 2 [V/V] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3State | map | output/state | Reported volumetric soil moisture content for both soil layer 3 [V/V] | +| INITIAL CONDITION | ThetaForestInit1Value | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | +| INITIAL CONDITION | ThetaForestInit2Value | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | +| INITIAL CONDITION | ThetaForestInit3Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | +| INITIAL CONDITION | ThetaInit1Value | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | +| INITIAL CONDITION | ThetaInit2Value | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | +| INITIAL CONDITION | ThetaInit3Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | +| INITIAL CONDITION | ThetaIrrigationInit1Value | value/map | input initial/internal | initial soil moisture content layer 1a for irrigation -9999: use field capacity values | +| INITIAL CONDITION | ThetaIrrigationInit2Value | value/map | input initial/internal | initial soil moisture content layer 1b for irrigation -9999: use field capacity values | +| INITIAL CONDITION | ThetaIrrigationInit3Value | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values | +| INITIAL CONDITION | timestepInit | value/date | input initial/internal | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | +| REPORTED OUTPUT MAPS | TopSoilMoistureMaps | map (missing) | output | Reported Topsoil moisture [%] | +| INITIAL CONDITION | TotalCrossSectionAreaInitValue | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | +| REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotalRunoffMaps | map | output | Reported total runoff [mm/∆t] | +| REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotaltoChanMaps | map | output | Reported total runoff that enters the channel: groundwater + surface runoff [mm/∆t] | +| TRANSMISSION LOSS | TransArea | value | input | downstream area taking into account for transmission loss | +| TRANSMISSION LOSS | TransPower1 | value | input | Transmission loss function parameter | +| TRANSMISSION LOSS | TransSub | value/map | input | Transmission loss function parameter | +| TRANSMISSION LOSS | UpAreaTrans | map | input | upstream area for transmission loss and k factor of reservoir module | +| GROUNDWATER RELATED PAR | UpperZoneTimeConstant | map | input | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | +| REPORTED OUTPUT MAPS (END) | UZEnd | map | output/end | Reported storage in upper groundwater zone response box [mm] | +| REPORTED OUTPUT MAPS (END) | UZForestEnd | map | output/end | Reported storage in upper groundwaterzone response box [mm] | +| INITIAL CONDITION | UZForestInitValue | map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZForestState | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| INITIAL CONDITION | UZInitValue | value/map | input initial/internal | water in upper groundwater zone [mm] | +| REPORTED OUTPUT MAPS (END) | UZIrrigationEnd | map | output/end | Reported storage in upper groundwater zone response box for irrigation [mm] | +| INITIAL CONDITION | UZIrrigationInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZIrrigationState | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | UZMaps | map | output | Reported storage in upper groundwater zone response box [mm] | +| REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | UZOutflowMaps | map | output | Reported upper groundwater zone outflow [mm/∆t] | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZState | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| REPORTED OUTPUT MAPS (END) | WaterDepthEnd | map | output/end | Reported overlandflow water depth | +| OUPUT | WaterDepthInitValue | map | input | initial overland flow water depth [mm] | +| REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | WaterDepthMaps | map | output | Reported water depth | +| REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | WaterDepthState | map | output | Reported overland flow water depth | +| REPORTED OUTPUT MAPS | WaterLevelMaps | map | output | Reported water level [m] | +| WATER USE MAPS AND PAR | WaterReUseFraction | 0 | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | +| WATER USE MAPS AND PAR | WaterSavingFraction | 0 | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | +| WATER USE MAPS AND PAR | WaterUseMaps | map | input | Reported water use m3 s-1 depending on the availability of discharge | +| WATER USE MAPS AND PAR | WaterUseTS | tss | input | Time series of upstream water use at gauging stations | +| EVAPORATION FROM OPEN WATER | WFracOfDay | map | input | table with days for each water use maps 1st column: range of days; 2nd column: suffix of wuse map | +| EVAPORATION FROM OPEN WATER | WFractionMaps | map | input | water use daily maps with a (in this case negative) volume of water [cu m/s] | +| WATER USE MAPS AND PAR | WUsePercRemain | value | input | percentage of water that must remain in a grid cell and is not withdrawn by water use e.g. 0.2 = 20 percent of discharge is not taken out | +| WATER USE MAPS AND PAR | WUseRegion | map | input | water use region | +| ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | +| INITIAL CONDITION | CumQEnd | map | output | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| INITIAL CONDITION | CumQInit | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| INITIAL CONDITION | cumSeepTopToSubBForestEnd | map | output | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| INITIAL CONDITION | cumSeepTopToSubBForestInit | value/map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| INITIAL CONDITION | cumSeepTopToSubBIrrigationEnd | map | output | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | value/map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| INITIAL CONDITION | cumSeepTopToSubBOtherEnd | map | output | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| INITIAL CONDITION | cumSeepTopToSubBOtherInit | value/map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| INITIAL CONDITION | LZInflowCumEnd | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| INITIAL CONDITION | LZInflowCumInit | value/map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| SETTINGS | MapsCaching | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | +| SETTINGS | NetCDFTimeChunks | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | +| SETTINGS | NumDaysSpinUp | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | +| SETTINGS | OutputMapsChunks | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | +| SETTINGS | OutputMapsDataType | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | +| DOUBLE KINEMATIC WAVE | QSplitMult | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | +| RESERVOIRS | ReservoirFloodOutflowFactor | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | +| RESERVOIRS | ReservoirFloodStorage | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | +| SOIL INIT | SeepTopToSubBAverageForestMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | +| SOIL INIT | SeepTopToSubBAverageIrrigationMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | +| SOIL INIT | SeepTopToSubBAverageOtherMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | +| INITIAL CONDITION | TimeSinceStartPrerunChunkEnd | map | output | Cumulative discharge. Required for the warm start of the pre-run. | +| INITIAL CONDITION | TimeSinceStartPrerunChunkInit | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | ## **Table:** *Variables required for model initialization.* -| section (XML) | module | KEY | In settings xml | Type | Cold Start: prerun and run | Warm Start: preun | Warm Start: run | Description | -|:------------------------|:-------------------------------------------|:----------------------------------------|:----------------------------------------------|:-----------------------------|:---------------------------------------------------------------|:---------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfuser | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | -9999 | ch2cro.end.nc | ch2cro.end.nc | initial channel crosssection for 2nd routing channel -9999: use 0 | -| lfuser | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | 0 | cumf.end.nc | cumf.end.nc | cumulative interception forest [mm] | -| lfuser | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | 0 | cum.end.nc | cum.end.nc | cumulative interception [mm] | -| lfuser | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | 0 | cumi.end.nc | cumi.end.nc | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfuser | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | 0 | cseal.end.nc | cseal.end.nc | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfuser | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | 1 | dslf.end.nc | dslf.end.nc | initial number of days since the last rainfall event for forest [days] | -| lfuser | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | 1 | dslr.end.nc | dslr.end.nc | days since last rainfall | -| lfuser | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | 1 | dsli.end.nc | dsli.end.nc | initial number of days since the last rainfall event for irrigation [days] | -| lfuser | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | 0 | frost.end.nc | frost.end.nc | initial frost index value | -| lfuser | INITIAL CONDITION | LZAvInflowMap | $(PathMaps)/lzavin.map | value/map | run: lzavin.nc; prerun: not needed | Not needed | Not needed | Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | -| lfuser | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | 0 | ofdir.end.nc | ofdir.end.nc | Reported water volume for direct fraction on catchment surface [m^3] | -| lfuser | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | 0 | offor.end.nc | offor.end.nc | Reported water volume for other fraction on catchment surface [m^3] | -| lfuser | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | 0 | ofoth.end.nc | ofoth.end.nc | Reported water volume for forest fraction on catchment surface [m^3] | -| lfuser | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | -9999 | prevcm.end.nc | prevcm.end.nc | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfuser | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | -9999 | chanq.end.nc | chanq.end.nc | initial discharge from previous run for MCT diffusive routing -9999: use 0 | -| lfuser | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | -9999 | chanqavgdt.end.nc | chanqavgdt.end.nc | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | -| lfuser | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | -9999 | prevdm.end.nc | prevdm.end.nc | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfuser | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | -9999 | chside.end.nc | chside.end.nc | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfuser | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | 0 | scova.end.nc | scova.end.nc | initial snow depth in snow zone A [mm] | -| lfuser | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone B [mm] | -| lfuser | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone C [mm] | -| lfuser | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | thf1.end.nd, prerun outpit (preferred0); -9999 | thf1.end.nc | thf1.end.nc | initial soil moisture content layer 1, forest -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | thf2.end.nd, prerun outpit (preferred0); -9999 | thf2.end.nc | thf2.end.nc | initial soil moisture content layer 2, forest -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | thf3.end.nd, prerun outpit (preferred0); -9999 | thf3.end.nc | thf3.end.nc | initial soil moisture content layer 3, forest -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | th1.end.nd, prerun outpit (preferred0); -9999 | th1.end.nc | th1.end.nc | initial soil moisture content layer 1, other fraction -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | th2.end.nd, prerun outpit (preferred0); -9999 | th2.end.nc | th2.end.nc | initial soil moisture content layer 2, other fraction -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | th3.end.nd, prerun outpit (preferred0); -9999 | th3.end.nc | th3.end.nc | initial soil moisture content layer 3, other fraction -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | thi1.end.nd, prerun outpit (preferred0); -9999 | thi1.end.nc | thi1.end.nc | initial soil moisture content layer 1, irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | thi2.end.nd, prerun outpit (preferred0); -9999 | thi2.end.nc | thi2.end.nc | initial soil moisture content layer 2, irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | thi3.end.nd, prerun outpit (preferred0); -9999 | thi3.end.nc | thi3.end.nc | initial soil moisture content layer 3, irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | Not Needed | value/date | value/date | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfuser | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | -9999 | chcro.end.nc | chcro.end.nc | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | -| lfuser | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | 0 | uzf.end.nc | uzf.end.nc | Initial water storage water in upper groundwater zone for forest [mm] | -| lfuser | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | 0 | uz.end.nc | uz.end.nc | water in upper groundwater zone [mm] | -| lfuser | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | 0 | uzi.end.nc | uzi.end.nc | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfuser | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | 0 | cumSeepTopToSubBForest.end.nc | Not needed | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | 0 | cumSeepTopToSubBIrrigated.end.nc | Not needed | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | 0 | cumSeepTopToSubBOther.end.nc | Not needed | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | map | 0 | LZInflowCum.end.nc | Not needed | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfuser | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | 0 | TimeSinceStartPrerunChunk.end.nc | Not needed | Cumulative discharge. Required for the warm start of the pre-run. | -| lfuser | INITIAL CONDITION | CumQInit | $(CumQInit) | map | 0 | CumQEnd.nc | Not needed | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | run: SeepTopToSubBAverageForestMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | run: SeepTopToSubBAverageIrrigationMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | run: SeepTopToSubBAverageOtherMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | AvgDis | $(PathMaps)/avgdis.map | map | run: avgdis.nc; prerun: not needed | Not needed | Not needed | Reported map of average discharge (reported for end of simulation) | -| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | -9999 | lz.end.nc | lz.end.nc | water in lower store [mm] -9999: use steady-state storage | +| section (XML) | KEY | Type | Cold Start: prerun and run | Warm Start: preun | Warm Start: run | Description | +|:------------------------|:----------------------------------------|:-----------------------------|:---------------------------------------------------------------|:---------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfuser | CrossSection2AreaInitValue | value/map | -9999 | ch2cro.end.nc | ch2cro.end.nc | initial channel crosssection for 2nd routing channel -9999: use 0 | +| lfuser | CumIntForestInitValue | value/map | 0 | cumf.end.nc | cumf.end.nc | cumulative interception forest [mm] | +| lfuser | CumIntInitValue | value/map | 0 | cum.end.nc | cum.end.nc | cumulative interception [mm] | +| lfuser | CumIntIrrigationInitValue | value/map | 0 | cumi.end.nc | cumi.end.nc | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| lfuser | CumIntSealedInitValue | value/map | 0 | cseal.end.nc | cseal.end.nc | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| lfuser | DSLRForestInitValue | value/map | 1 | dslf.end.nc | dslf.end.nc | initial number of days since the last rainfall event for forest [days] | +| lfuser | DSLRInitValue | value/map | 1 | dslr.end.nc | dslr.end.nc | days since last rainfall | +| lfuser | DSLRIrrigationInitValue | value/map | 1 | dsli.end.nc | dsli.end.nc | initial number of days since the last rainfall event for irrigation [days] | +| lfuser | FrostIndexInitValue | value/map | 0 | frost.end.nc | frost.end.nc | initial frost index value | +| lfuser | LZAvInflowMap | value/map | run: lzavin.nc; prerun: not needed | Not needed | Not needed | Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | +| lfuser | OFDirectInitValue | value/map | 0 | ofdir.end.nc | ofdir.end.nc | Reported water volume for direct fraction on catchment surface [m^3] | +| lfuser | OFForestInitValue | value/map | 0 | offor.end.nc | offor.end.nc | Reported water volume for other fraction on catchment surface [m^3] | +| lfuser | OFOtherInitValue | value/map | 0 | ofoth.end.nc | ofoth.end.nc | Reported water volume for forest fraction on catchment surface [m^3] | +| lfuser | PrevCmMCTInitValue | value/map | -9999 | prevcm.end.nc | prevcm.end.nc | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| lfuser | PrevDischarge | value/map | -9999 | chanq.end.nc | chanq.end.nc | initial discharge from previous run for MCT diffusive routing -9999: use 0 | +| lfuser | PrevDischargeAvg | value/map | -9999 | chanqavgdt.end.nc | chanqavgdt.end.nc | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | +| lfuser | PrevDmMCTInitValue | value/map | -9999 | prevdm.end.nc | prevdm.end.nc | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| lfuser | PrevSideflowInitValue | value/map | -9999 | chside.end.nc | chside.end.nc | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| lfuser | SnowCoverAInitValue | value/map | 0 | scova.end.nc | scova.end.nc | initial snow depth in snow zone A [mm] | +| lfuser | SnowCoverBInitValue | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone B [mm] | +| lfuser | SnowCoverCInitValue | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone C [mm] | +| lfuser | ThetaForestInit1Value | value/map | thf1.end.nd, prerun outpit (preferred0); -9999 | thf1.end.nc | thf1.end.nc | initial soil moisture content layer 1, forest -9999: use field capacity values | +| lfuser | ThetaForestInit2Value | value/map | thf2.end.nd, prerun outpit (preferred0); -9999 | thf2.end.nc | thf2.end.nc | initial soil moisture content layer 2, forest -9999: use field capacity values | +| lfuser | ThetaForestInit3Value | value/map | thf3.end.nd, prerun outpit (preferred0); -9999 | thf3.end.nc | thf3.end.nc | initial soil moisture content layer 3, forest -9999: use field capacity values | +| lfuser | ThetaInit1Value | value/map | th1.end.nd, prerun outpit (preferred0); -9999 | th1.end.nc | th1.end.nc | initial soil moisture content layer 1, other fraction -9999: use field capacity values | +| lfuser | ThetaInit2Value | value/map | th2.end.nd, prerun outpit (preferred0); -9999 | th2.end.nc | th2.end.nc | initial soil moisture content layer 2, other fraction -9999: use field capacity values | +| lfuser | ThetaInit3Value | value/map | th3.end.nd, prerun outpit (preferred0); -9999 | th3.end.nc | th3.end.nc | initial soil moisture content layer 3, other fraction -9999: use field capacity values | +| lfuser | ThetaIrrigationInit1Value | value/map | thi1.end.nd, prerun outpit (preferred0); -9999 | thi1.end.nc | thi1.end.nc | initial soil moisture content layer 1, irrigation -9999: use field capacity values | +| lfuser | ThetaIrrigationInit2Value | value/map | thi2.end.nd, prerun outpit (preferred0); -9999 | thi2.end.nc | thi2.end.nc | initial soil moisture content layer 2, irrigation -9999: use field capacity values | +| lfuser | ThetaIrrigationInit3Value | value/map | thi3.end.nd, prerun outpit (preferred0); -9999 | thi3.end.nc | thi3.end.nc | initial soil moisture content layer 3, irrigation -9999: use field capacity values | +| lfuser | timestepInit | value/date | Not Needed | value/date | value/date | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | +| lfuser | TotalCrossSectionAreaInitValue | value/map | -9999 | chcro.end.nc | chcro.end.nc | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | +| lfuser | UZForestInitValue | map | 0 | uzf.end.nc | uzf.end.nc | Initial water storage water in upper groundwater zone for forest [mm] | +| lfuser | UZInitValue | value/map | 0 | uz.end.nc | uz.end.nc | water in upper groundwater zone [mm] | +| lfuser | UZIrrigationInitValue | value/map | 0 | uzi.end.nc | uzi.end.nc | Initial water storage water in upper groundwater zone for irrigation [mm] | +| lfuser | cumSeepTopToSubBForestInit | value/map | 0 | cumSeepTopToSubBForest.end.nc | Not needed | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | cumSeepTopToSubBIrrigationInit | value/map | 0 | cumSeepTopToSubBIrrigated.end.nc | Not needed | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | cumSeepTopToSubBOtherInit | value/map | 0 | cumSeepTopToSubBOther.end.nc | Not needed | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | LZInflowCumInit | map | 0 | LZInflowCum.end.nc | Not needed | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfuser | TimeSinceStartPrerunChunkInit | map | 0 | TimeSinceStartPrerunChunk.end.nc | Not needed | Cumulative discharge. Required for the warm start of the pre-run. | +| lfuser | CumQInit | map | 0 | CumQEnd.nc | Not needed | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfbinding | SeepTopToSubBAverageForestMap | map | run: SeepTopToSubBAverageForestMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | +| lfbinding | SeepTopToSubBAverageIrrigationMap | map | run: SeepTopToSubBAverageIrrigationMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | +| lfbinding | SeepTopToSubBAverageOtherMap | map | run: SeepTopToSubBAverageOtherMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | +| lfbinding | AvgDis | map | run: avgdis.nc; prerun: not needed | Not needed | Not needed | Reported map of average discharge (reported for end of simulation) | +| lfbinding | LZInitValue | value/map | -9999 | lz.end.nc | lz.end.nc | water in lower store [mm] -9999: use steady-state storage | + From ab967cbdcf4e8a68d1e5e04d690d74a79a46f5c7 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 11:36:48 +0200 Subject: [PATCH 56/70] update descrition lfbinding and lfuser --- .../index.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md index c6d84961..4302aad0 100644 --- a/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md +++ b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md @@ -49,23 +49,33 @@ The sections ‘lfuser’, ‘lfoptions’ and ‘lfbinding’' have different p - Options that activate OS LISFLOOD optional modules, such as simulate reservoirs, lakes, etc. - Options to activate the reporting of additional output maps and time series (e.g. soil moisture maps) - A comprehensive list of available options and default values is contained in the [Annex: settings and options](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/). + Options are set to active using "1" (viceversa, "0" means that the option is de-activated). Users are not obliged to include all available options in Settings.xml file: if one option is not specified in Settings.xml, the default option will be automatically used. If Users leave the ‘lfoptions’ element empty, LISFLOOD will simply run using default options (i.e. run model without optional modules; only report most basic output files). However, the ‘lfoptions’ element itself (i.e. ) has to be present, even if empty. + A comprehensive list of available options and default values is contained in the [Annex: settings and options](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/). + + **lfuser** contains user-defined definition of **paths** to all in- and output files, and main model parameters (calibration + time-related). The variables in the ‘lfuser’ elements are all text variables, and they are used simply to substitute repeatedly used expressions in the binding element. + OS LISFLOOD code makes use of the settings in the 'lfbinding' section (see below). 'lfbinding' section includes all the settings. 'lfuser' section includes the subset of settings that are often changed by users. If a setting in the 'lfbinding' section refers to the 'lfuser' section, OS LISFLOOD code will use the latter one. + For example: +```xml + 'lfuser' secttion: + + 'lfbinding' secttion: + +``` + **lfbinding** contains definition of **all parameter values** of LISFLOOD model as well as **all in- and output maps, time series and tables**. - It is possible to define everything directly in the ‘lfbinding’ element without using any text variables at al. In that case, the ‘lfuser’ element can remain empty, even though it has to be present (i.e. ) [NOT recommended] + Since OS LISFLOOD code refers to the ‘lfbinding’ section, it is possible to define everything directly in the ‘lfbinding’ section without using any text variables in 'lfuser' section. In that case, the ‘lfuser’ element can remain empty, even though it has to be present (i.e. ). - In general, it is a good idea to use user-defined variables for everything that needs to be changed on a regular basis (paths to input maps, tables, meteorological data, and parameter values). This way Users only have to deal with the variables in the ‘lfuser’ element, without having to worry about anything in ‘lfbinding’ at all. “lfuser” allows to have all the important variables defined in the same element. + In general, it is a good idea to use user-defined variables for everything that needs to be changed on a regular basis (paths to input maps, tables, meteorological data, and parameter values). According to this approachm users will only need to verify and edit the variables in the ‘lfuser’ element, and changes to ‘lfbinding’ are not required. From b4ec704ca4ebe7cfedc10575f881ef5fefc1aed0 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 11:42:04 +0200 Subject: [PATCH 57/70] essential concepts: add hyperlinks --- docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md index 4302aad0..255e478b 100644 --- a/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md +++ b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md @@ -1,9 +1,9 @@ # Essential concepts This page presents: -- an overview of the required files and folders -- an overview of the OS LISFLOOD Settings.xml file (the main and essential argument of OS LISFLOOD command line) -- the time convention within lisflood, understanding of the latter is **essential for a correct model set-up**. +- an overview of the [required files and folders](../3_step1_ESSENTIAL_concepts_to_get_started/index.md#what-is-needed-to-run-a-os-lisflood-model) +- an overview of the [OS LISFLOOD Settings.xml](../3_step1_ESSENTIAL_concepts_to_get_started/index.md#os-lisflood-settings-file-settingsxml) (the main and essential argument of OS LISFLOOD command line) +- the [time convention within lisflood](../3_step1_ESSENTIAL_concepts_to_get_started/index.md#time-convention-within-os-lisflood-model), understanding of the latter is **essential for a correct model set-up**. ## What is needed to run a OS LISFLOOD model? From 1b1fb9fc28bc8be4a5d446efe5227934a0592b15 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 11:46:07 +0200 Subject: [PATCH 58/70] re-organize sections --- .../index.md | 166 ------------------ docs/_config.yml | 2 +- 2 files changed, 1 insertion(+), 167 deletions(-) delete mode 100644 docs/2_ESSENTIAL_concepts_before_getting_started/index.md diff --git a/docs/2_ESSENTIAL_concepts_before_getting_started/index.md b/docs/2_ESSENTIAL_concepts_before_getting_started/index.md deleted file mode 100644 index c6d84961..00000000 --- a/docs/2_ESSENTIAL_concepts_before_getting_started/index.md +++ /dev/null @@ -1,166 +0,0 @@ -# Essential concepts - -This page presents: -- an overview of the required files and folders -- an overview of the OS LISFLOOD Settings.xml file (the main and essential argument of OS LISFLOOD command line) -- the time convention within lisflood, understanding of the latter is **essential for a correct model set-up**. - -## What is needed to run a OS LISFLOOD model? - -In order the run a simulation you will need: - - - Meteo input maps - - Static input maps - - Tables, only in case specific features such as reservoirs and lakes are included in the modeling excercis - - An empty output directory where all model data can be written - - OS LISFLOOD settings file in .xml format - -The section [Input files](../3_step4_preparing-input-files) provides a detailed description of input maps and tables. - -The settings file (settings.xml) allows the selection of input maps, modelling options, and output variables and storage folder. The settings .xml is the essential argument of OS LISFLOOD command line. The section below presents its main components, an in depth descrition is provided in the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/). - - -## OS LISFLOOD settings file (settings.xml) - - -All input files, output files, and parameter specifications are defined in a settings file. This file links variables and parameters in the model to in- and output files (maps, time series, tables) and numerical values. Moreover, the settings file can be used to specify the various model *options*. The settings file has a special (XML) structure. This page explains the general layout of the settings file; the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of all the components of the file. - -A LISFLOOD settings file is made up of 3 elements, each of which has a specific function. - -For a LISFLOOD settings file, the basic structure looks like this: -
-**\**    Start of settings elements
-   **\**    Start of element with options
-                         LISFLOOD options (switches)
-   **\**    End of element with options
-   **\**    Start of element with user-defined variables
-                         User's specific parameters and settings
-   **\**    End of element with user-defined variables
-   **\**    Start of element with 'binding' variables
-                         LISFLOOD model general settings
-   **\**    End of element with 'binding' variables
-**\**    End of settings element
- - -### Main elements of the settings file -The sections ‘lfuser’, ‘lfoptions’ and ‘lfbinding’' have different purposes, as described below. - -+ **lfoptions** contains **switches to turn on/off specific components of the model**. Within LISFLOOD, there are two categories of options: - - Options that activate OS LISFLOOD optional modules, such as simulate reservoirs, lakes, etc. - - Options to activate the reporting of additional output maps and time series (e.g. soil moisture maps) - - A comprehensive list of available options and default values is contained in the [Annex: settings and options](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/). - - Users are not obliged to include all available options in Settings.xml file: if one option is not specified in Settings.xml, the default option will be automatically used. - If Users leave the ‘lfoptions’ element empty, LISFLOOD will simply run using default options (i.e. run model without optional modules; only report most basic output files). - However, the ‘lfoptions’ element itself (i.e. ) has to be present, even if empty. - - -+ **lfuser** contains user-defined definition of **paths** to all in- and output files, and main model parameters (calibration + time-related). - - The variables in the ‘lfuser’ elements are all text variables, and they are used simply to substitute repeatedly used expressions in the binding element. - - -+ **lfbinding** contains definition of **all parameter values** of LISFLOOD model as well as **all in- and output maps, time series and tables**. - - It is possible to define everything directly in the ‘lfbinding’ element without using any text variables at al. In that case, the ‘lfuser’ element can remain empty, even though it has to be present (i.e. ) [NOT recommended] - - In general, it is a good idea to use user-defined variables for everything that needs to be changed on a regular basis (paths to input maps, tables, meteorological data, and parameter values). This way Users only have to deal with the variables in the ‘lfuser’ element, without having to worry about anything in ‘lfbinding’ at all. “lfuser” allows to have all the important variables defined in the same element. - - - - -## Time convention within OS LISFLOOD model - -**LISFLOOD model follows an "end of timestep" naming convention** for timestamps of both input (forcings) and output data. - -Accordingly, if timestamp "02/01/2017 06:00" is used for naming a time step of daily accumulated rainfall data, that time step will contain rainfall accumulation between "01/01/2017 06:00" and "02/01/2017 06:00" (see following figure) - -![](../media/image62.png) - -Outputs of LISFLOOD model will use the same naming convention. If timestamp "02/01/2017 06:00" is used for naming a time step of daily discharge (output), that time step will contain average discharge over the period between "01/01/2017 06:00" and "02/01/2017 06:00" (see following figure) - -![](../media/image63.png) - -In Settings file, three different keys are used to specify start date, end date and state file date for LISFLOOD simulation: - -- **StepStart:** this key specifies the starting date of the simulation. The starting date is also the date of the first LISFLOOD output. - >In Settings.xml: textvar name="StepStart" value="02/01/2017 06:00" - - >For example, if we set StepStart to "02/01/2017 06:00", this means that LISFLOOD will automatically use forcing data with timestamp "02/01/2017 06:00" (i.e. accumulated rainfall over the period between "01/01/2017 06:00" and "02/01/2017 06:00") and it will also store outputs with the same timestamp (i.e. average discharge over the period between "01/01/2017 06:00" and "02/01/2017 06:00"). - -- **StepEnd:** this key specifies the end date of the simulation. The end date is also the date of the last LISFLOOD output. - >In Settings.xml: textvar name="StepEnd value="05/01/2017 06:00" - - > For example, if we set StepEnd to "05/01/2017 06:00", this means that last output from LISFLOOD run will have timestamp "05/01/2017 06:00" - -- **timestepInit:** this key is used to specify which timestamp must be used to retrieve information from existing state files (i.e. from a previous simulation) - >For example, if we want to start a new simulation at "03/01/2017 06:00" and we want to use hydrological state information from the last time step, we will set timestepInit to "02/01/2017 06:00". Outputs with timestamp "02/01/2017 06:00" will be used to initialize the model, while the first output of the simulation will be be store with timestamp "03/01/2017 06:00" - -![](../media/image64.png) - -> **Both timestamps and time steps ALWAYS refer to the END of the TIME INTERVAL!** - - -### Using timestamps - -Timestamps (dates) can be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart ([Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of the Settings.xml file). - -If hours:minutes are not specified, LISFLOOD will automatically set them to 00:00 - -When using timestamps, CalendarDayStart key in Settings.xml is only used internally to transform timestamps to model's time steps. - -StepStart, StepEnd and timestepInit are used to access NetCDF files containing forcings and state variables, and to create output NetCDF files. - - -```xml - - ************************************************************** - TIME-RELATED CONSTANTS - ************************************************************** - - - - Calendar day of 1st day in model run - Day of the year of first map (e.g. xx0.001) even if the model start - from map e.g. 500 - e.g. 1st of January: 1; 1st of June 151 (or 152 in leap year) - Needed to read out LAI tables correctly - - - - - timestep [seconds] - - - - - Sub time step used for kinematic wave channel routing [seconds] - - - - - Number of first time step in simulation - - - - - Number of last time step in simulation - - - - - Time steps at which to write model state maps - - -``` - - - -### Using time steps - -Time steps can still be used to set start step and end step of LISFLOOD simulation. ReportSteps can only be provided as time steps numbers. - -All steps numbers are referred to CalendarDayStart - -When using time steps, dates (including hours and minutes) to retrieve data for forcings and state variables are automatically determined by LISFLOOD. diff --git a/docs/_config.yml b/docs/_config.yml index 0fae6efb..daf1f3d3 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -203,7 +203,7 @@ defaults: - section_title: "Step-by-step user guide" items: - title: "Step 1: Essential concepts to get started" - url: 2_step1_ESSENTIAL_concepts_to_get_started + url: 3_step1_ESSENTIAL_concepts_to_get_started - title: "Step 2: Preparing the settings file" url: 3_step2_preparing-setting-file - title: "Step 3: Preparing input files" From f610eeb07b21a788522f5bfc281b0938aec3d580 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 16:50:47 +0200 Subject: [PATCH 59/70] review Annex Input Maps Standard modules. Rename Annexes to 5 --- docs/4_annex_input-files/index.md | 121 ---- .../index.md | 126 ++++ .../index.md | 0 .../index.md | 0 .../index.md | 0 docs/5_annex_settings_and_options/index_v1.md | 577 ++++++++++++++++++ .../index.md | 0 .../{4_annex_tests => 5_annex_tests}/index.md | 0 8 files changed, 703 insertions(+), 121 deletions(-) delete mode 100644 docs/4_annex_input-files/index.md create mode 100644 docs/5_annex_input-maps-standard-modules/index.md rename docs/{4_annex_output-files => 5_annex_output-files}/index.md (100%) rename docs/{4_annex_parameters => 5_annex_parameters}/index.md (100%) rename docs/{4_annex_settings_and_options => 5_annex_settings_and_options}/index.md (100%) create mode 100644 docs/5_annex_settings_and_options/index_v1.md rename docs/{4_annex_state-variables => 5_annex_state-variables}/index.md (100%) rename docs/{4_annex_tests => 5_annex_tests}/index.md (100%) diff --git a/docs/4_annex_input-files/index.md b/docs/4_annex_input-files/index.md deleted file mode 100644 index 5f25b9df..00000000 --- a/docs/4_annex_input-files/index.md +++ /dev/null @@ -1,121 +0,0 @@ -# LISFLOOD input files - -All input that LISFLOOD requires are either in map or table format. Before showing a listing of all LISFLOOD input files, first some important remarks on the meteorological input data LISFLOOD requires. - - -## Treatment of meteorological input variables - -The meteorological conditions provide the driving forces behind the water balance. LISFLOOD uses the following meteorological input variables: - - -| **Code** | **Description** | **Unit** | -| --------- | -------------------------------------------------- | ------------------ | -| $P$ | Precipitation | $[\frac{mm}{day}]$ | -| $ET0$ | Potential (reference) evapotranspiration rate | $[\frac{mm}{day}]$ | -| $EW0$ | Potential evaporation rate from open water surface | $[\frac{mm}{day}]$ | -| $ES0$ | Potential evaporation rate from bare soil surface | $[\frac{mm}{day}]$ | -| $T_{avg}$ | Average *daily* temperature | $^\circ C$ | - -> **Note** that the model needs *daily* average temperature values, even if the model is run on a smaller time interval (e.g. hourly). This is because the routines for snowmelt and soil freezing are use empirical relations which are based on daily temperature data.. Just as an example, feeding hourly temperature data into the snowmelt routine can result in a gross overestimation of snowmelt. This is because even on a day on which the average temperature is below $T_m$ (no snowmelt), the instantaneous (or hourly) temperature may be higher for a part of the day, leading to unrealistically high simulated snowmelt rates. - - -Both precipitation and evaporation are internally converted from *intensities* $[\frac{mm}{day}]$ to *quantities per time step* $[mm]$ by multiplying them with the time step, $\Delta t$ (in $days$). -For the sake of consistency, all in- and outgoing fluxes will also be described as *quantities per time step* $[mm]$ in the following, unless stated otherwise. -$ET0$, $EW0$ and $ES0$ can be calculated using standard meteorological observations. - -To this end a dedicated pre-processing application has been developed (LISVAP), which is documented in a separate [manual](https://ec-jrc.github.io/lisflood-lisvap/). - - - -## LISFLOOD input maps - - -***Table:*** *LISFLOOD input maps.* - -| Map | Default name | Units, range | Description | -| --------------------------------------------------------- | ------------------- | ------------------------------------------------------ | ------------------------------------------------------------ | -| **GENERAL** | | | | -| MaskMap | area.map | Unit: -
Range: 0 or 1 | Boolean map that defines model boundaries | -| **TOPOGRAPHY** | | | | -| Ldd | ldd.map | U.: flow directions
R.: 1 ≤ map ≤ 9 | local drain direction map (with value 1-9); this file contains flow directions from each cell to its steepest downslope neighbour. Ldd directions are coded according to the following diagram:
![](../media/image58.png)
This resembles the numeric key pad of your PC's keyboard, except for the value 5, which defines a cell without local drain direction (pit). The pit cell at the end of the path is the outlet point of a catchment. | -| Grad | gradient.map | U.: $\frac{m}{m}$
R.: map > 0
| Slope gradient | -| Elevation Stdev | elvstd.map | U.: $m$
R.: map ≥ 0 | Standard deviation of elevation | -| **LAND USE -- fraction maps** | | | | -| Fraction of water | fracwater.map | U.: [-]
R.: 0 ≤ map ≤ 1 | Fraction of inland water for each cell. Values range from 0 (no water at all) to 1 (pixel is 100% water) | -| Fraction of sealed surface | fracsealed.map | U.: [-]
R.: 0 ≤ map ≤ 1 | Fraction of impermeable surface for each cell. Values range from 0 (100% permeable surface -- no urban at all) to 1 (100% impermeable surface). | -| Fraction of forest | fracforest.map | U.:[-]
R.: 0 ≤ map ≤ 1 | Forest fraction for each cell. Values range from 0 (no forest at all) to 1 (pixel is 100% forest) | -| Fraction of other land cover | fracother.map | U.: [-]
R.: 0 ≤ map ≤ 1 | Other (agricultural areas, non-forested natural area, pervious surface of urban areas) fraction for each cell. | -| **LAND COVER depending maps** | | | | -| Crop coef. for forest | cropcoef_forest.map | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for forest | -| Crop coef. for other | cropcoef_other.map | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for other | -| Crop group number for forest | crgrnum_forest.map | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for forest | -| Crop group number for forest | crgrnum_other.map | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for other | -| Manning for forest | mannings_forest.map | U.: $m^{-1/3} s$
R.: 0.2≤ map ≤ 0.4 | Manning's roughness for forest | -| Manning for other | mannings_other.map | U.: $m^{-1/3} s$
R.: 0.01≤ map ≤0.3 | Manning's roughness for other | -| Soil depth for forest for layer1a | soildep1a_forest.map | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 1a | -| Soil depth for other for layer1a | soildep1a_other.map | U.: $mm$
R.: map ≥ 50 | Other soil depth for soil layer 1a | -| Soil depth for forest for layer1b | soildep1b_forest.map | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 1b | -| Soil depth for other for layer1b | soildep1b_other.map | U.: $mm$
R.: map ≥ 50 | Other soil soil depth for soil layer 1b | -| Soil depth for forest for layer2 | soildep2_forest.map | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 2 | -| Soil depth for other for layer2 | soildep2_other.map | U.: $mm$
R.: map ≥ 50 | Other soil soil depth for soil layer 2 | -| **SOIL HYDRAULIC PROPERTIES (depending on soil texture)** | | | | -| ThetaSat1a for forest | thetas1a_forest.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1a | -| ThetaSat1a for other | thetas1a_other.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1a | -| ThetaSat1b for forest | thetas1b_forest.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1b | -| ThetaSat1b for other | thetas1b_other.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1b | -| ThetaSat2 for forest and other | thetas2.map | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 2 | -| ThetaRes1a for forest | thetar1a_forest.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1a | -| ThetaRes1a for other | thetar1a_other.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1a | -| ThetaRes1b for forest | thetar1b_forest.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1b | -| ThetaRes1b for other | thetar1b_other.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1b | -| ThetaRes2 for forest and other | thetar2.map | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 2 | -| Lambda1a for forest | lambda1a_forest.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1a | -| Lambda1a for other | lambda1a_other.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1a | -| Lambda1b for forest | lambda1b_forest.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1b | -| Lambda1b for other | lambda1b_other.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 1b -| Lambda2 for forest and other | lambda2.map | U.: [-]
R.: map>0 | Pore size index (λ) layer 2 | -| GenuAlpha1a for forest | alpha1a_forest.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1a | -| GenuAlpha1a for other | alpha1a_other.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1a | -| GenuAlpha1b for forest | alpha1b_forest.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1b | -| GenuAlpha1b for other | alpha1b_other.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1b | -| GenuAlpha2 for forest and other | alpha2.map | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 2 | -| Sat1a for forest | ksat1a_forest.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1a | -| Sat1a for other | ksat1a_other.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1a | -| Sat1b for forest | ksat1b_forest.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1b | -| Sat1b for other | ksat1b_other.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1b | -| Sat2 for forest and other | ksat2.map | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 2 | -| **CHANNEL GEOMETRY** | | | | -| Channels | chan.map | U.: [-]
R.: 0 or 1 | Map with Boolean 1 for all channel pixels, and Boolean 0 for all other pixels on MaskMap | -| MCT Channels | chanmct.map | U.: [-]
R.: 0 or 1 | Map with Boolean 1 for channel pixels using MCT diffusive wave routing, and Boolean 0 for all other pixels on MaskMap | -| ChanGrad | changrad.map | U.: $\frac{m} {m}$
R.: map > 0
!!! | Channel gradient | -| ChanMan | chanman.map | U.: $m^{-1/3} s$
R.: map > 0 | Manning's roughness coefficient for channels | -| ChanLength | chanleng.map | U.: $m$
R.: map > 0 | Channel length (can exceed grid size, to account for meandering rivers) | -| ChanBottomWidth | chanbw.map | U.: $m$
R.: map > 0 | Channel bottom width | -| ChanSdXdY | chans.map | U.: $\frac{m} {m}$
R.: map ≥ 0 | Channel side slope Important: defined as horizontal divided by vertical distance (dx/dy); this may be confusing because slope is usually defined the other way round (i.e. dy/dx)! | -| ChanDepthThreshold | chanbnkf.map | U.: $m$
R.: map > 0 | Bankfull channel depth | -| **METEOROLOGICAL VARIABLES** | | | | -| PrecipitationMaps | pr | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Precipitation rate | -| TavgMaps | ta | U.: $°C$
R.:-50 ≤map ≤ +50 | Average daily temperature | -| E0Maps | e | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evaporation rate, free water surface | -| ES0Maps | es | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evaporation rate, bare soil | -| ET0Maps | et | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evapotranspiration rate, reference crop | -| **DEVELOPMENT OF VEGETATION OVER TIME** | | | | -| LAIMaps for forest | lai_forest | U.: $\frac{m^2} {m^2}$
R.: map ≥ 0 | Pixel-average Leaf Area Index for forest | -| LAIMaps for other | lai_other | U.: $\frac{m^2} {m^2}$
R.: map ≥ 0 | Pixel-average Leaf Area Index for other | -| **DEFINITION OF INPUT/OUTPUT TIMESERIES** | | | | -| Gauges | outlets.map | U.: [-]
R.: For each station an individual number | Nominal map with locations at which discharge timeseries are reported (usually correspond to gauging stations) | -| Sites | sites.map | U.: [-]
R.: For each station an individual number | Nominal map with locations (individual pixels or areas) at which timeseries of intermediate state and rate variables are reported (soil moisture, infiltration, snow, etcetera) | - - - -***Table:*** *Optional maps that define grid size.* - -| Map | Default name | Units, range | Description | -| --------------- | ------------ | ------------------------ | --------------------- | -| PixelLengthUser | pixleng.map | U.: $m$
R.: map > 0 | Map with pixel length | -| PixelAreaUser | pixarea.map | U.: $m$
R.: map > 0 | Map with pixel area | - - - -[🔝](#top) - diff --git a/docs/5_annex_input-maps-standard-modules/index.md b/docs/5_annex_input-maps-standard-modules/index.md new file mode 100644 index 00000000..d5cbd92c --- /dev/null +++ b/docs/5_annex_input-maps-standard-modules/index.md @@ -0,0 +1,126 @@ +# LISFLOOD input maps for standard modules + +LISFLOOD requires input files in map or text format (the latter are called *tables*). The detailed description is provided in [this chapter](../4_Static-Maps-introduction) of LISFLOOD User Guide. + +This Annex reiterates the guidelines for the prearation of meteorological varaibles and provides the list of LISFLOOD input maps required when only the standard modules are used. +The description of the optional modules in the [OS LISFLOOD Model Documentation](https://ec-jrc.github.io/lisflood-model/) includes also the list of additional maps and tables. + + + +## Units of meteorological input variables + +The meteorological conditions provide the driving forces behind the water balance. LISFLOOD uses the following meteorological input variables: + + +| **Code** | **Description** | **Unit** | +| --------- | -------------------------------------------------- | ------------------ | +| $P$ | Precipitation | $[\frac{mm}{day}]$ | +| $ET0$ | Potential (reference) evapotranspiration rate | $[\frac{mm}{day}]$ | +| $EW0$ | Potential evaporation rate from open water surface | $[\frac{mm}{day}]$ | +| $ES0$ | Potential evaporation rate from bare soil surface | $[\frac{mm}{day}]$ | +| $T_{avg}$ | Average temperature | $^\circ C$ or $K $ | + + +Both precipitation and evaporation are internally converted from *intensities* $[\frac{mm}{day}]$ to *quantities per time step* $[mm]$ by multiplying them with the time step, $\Delta t$ (in $days$). +For the sake of consistency, all in- and outgoing fluxes will also be described as *quantities per time step* $[mm]$ in the following, unless stated otherwise. + +$ET0$, $EW0$ and $ES0$ can be calculated using standard meteorological observations. [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/) could be used for this purpose. + + + +## LISFLOOD input maps for standard modules + + +***Table:*** *LISFLOOD input maps.* + +| Map | Default name | Units, range | Description | +| --------------------------------------------------------- | ------------------- | ------------------------------------------------------ | ------------------------------------------------------------ | +| **GENERAL** | | | | +| MaskMap | area.nc | Unit: -
Range: 0 or 1 | Boolean map that defines model boundaries | +| **TOPOGRAPHY** | | | | +| Ldd | ldd.nc | U.: flow directions
R.: 1 ≤ map ≤ 9 | local drain direction map (with value 1-9); this file contains flow directions from each cell to its steepest downslope neighbour. Ldd directions are coded according to the following diagram:
![](../media/image58.png)
This resembles the numeric key pad of your PC's keyboard, except for the value 5, which defines a cell without local drain direction (pit). The pit cell at the end of the path is the outlet point of a catchment. | +| Grad | gradient.nc | U.: $\frac{m}{m}$
R.: map > 0
| Slope gradient | +| Elevation Stdev | elvstd.nc | U.: $m$
R.: map ≥ 0 | Standard deviation of elevation | +| **LAND USE -- fraction maps** | | | | +| Fraction of water | fracwater.nc | U.: [-]
R.: 0 ≤ map ≤ 1 | Fraction of inland water for each cell. Values range from 0 (no water at all) to 1 (pixel is 100% water) | +| Fraction of sealed surface | fracsealed.nc | U.: [-]
R.: 0 ≤ map ≤ 1 | Fraction of impermeable surface for each cell. Values range from 0 (100% permeable surface -- no urban at all) to 1 (100% impermeable surface). | +| Fraction of forest | fracforest.nc | U.:[-]
R.: 0 ≤ map ≤ 1 | Forest fraction for each cell. Values range from 0 (no forest at all) to 1 (pixel is 100% forest) | +| Fraction of irrigated areas | fracirrigation.nc | U.:[-]
R.: 0 ≤ map ≤ 1 | Irrigated fraction for each cell. Values range from 0 to 1 | +| Fraction of rice fields | fracrice.nc | U.:[-]
R.: 0 ≤ map ≤ 1 | Fraction for each cell dedicated to paddy rice crops. Values range from 0 to 1 | +| Fraction of other land cover | fracother.nc | U.: [-]
R.: 0 ≤ map ≤ 1 | Other (non-forested natural area, pervious surface of urban areas, shrubs abd bushes, ...) fraction for each cell. | +| **LAND COVER depending maps** | | | | +| Crop coef. for forest | cropcoef_forest.nc | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for forest | +| Crop coef. for other | cropcoef_other.nc | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for other | +| Crop group number for forest | crgrnum_forest.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for forest | +| Crop group number for forest | crgrnum_other.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for other | +| Crop group number for irrigation | crgrnum_irr.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for irrigation | +| Manning for forest | mannings_forest.nc | U.: $m^{-1/3} s$
R.: 0.2≤ map ≤ 0.4 | Manning's roughness for forest | +| Manning for other | mannings_other.nc | U.: $m^{-1/3} s$
R.: 0.01≤ map ≤0.3 | Manning's roughness for other | +| Manning for irrigation | mannings_irr.nc | U.: $m^{-1/3} s$
R.: 0.01≤ map ≤0.3 | Manning's roughness for irrigation | +| Soil depth for forest for layer1 | soildepth1_forest.nc | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 1 | +| Soil depth for other for layer1 | soildepth1_other.nc | U.: $mm$
R.: map ≥ 50 | Other soil depth for soil layer 1 | +| Soil depth for forest for layer2 | soildepth2_forest.nc | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 2 | +| Soil depth for other for layer2 | soildepth2_other.nc | U.: $mm$
R.: map ≥ 50 | Other soil soil depth for soil layer 2 | +| Soil depth for forest for layer3 | soildepth3_forest.nc | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 3 | +| Soil depth for other for layer3 | soildepth3_other.nc | U.: $mm$
R.: map ≥ 50 | Other soil soil depth for soil layer 3 | +| **SOIL HYDRAULIC PROPERTIES (depending on soil texture)** | | | | +| ThetaSat1 for forest | thetas1_forest.nc | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1 | +| ThetaSat1 for other | thetas1_other.nc | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 1 | +| ThetaSat2 for forest | thetas2_forest.nc | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 2 | +| ThetaSat2 for other | thetas2_other.nc | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 2 | +| ThetaSat3 for forest and other | thetas2.nc | U.: [V/V]
R.: 0 < map < 1 | Saturated volumetric soil moisture content layer 3 | +| ThetaRes1 for forest | thetar1_forest.nc | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1 | +| ThetaRes1 for other | thetar1_other.nc | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 1 | +| ThetaRes2 for forest | thetar2_forest.nc | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 2 | +| ThetaRes2 for other | thetar2_other.nc | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 2 | +| ThetaRes3 for forest and other | thetar2.nc | U.: [V/V]
R.: 0 < map < 1 | Residual volumetric soil moisture content layer 3 | +| Lambda1 for forest | lambda1_forest.nc | U.: [-]
R.: map>0 | Pore size index (λ) layer 1 | +| Lambda1 for other | lambda1_other.nc | U.: [-]
R.: map>0 | Pore size index (λ) layer 1 | +| Lambda2 for forest | lambda2_forest.nc | U.: [-]
R.: map>0 | Pore size index (λ) layer 2 | +| Lambda2 for other | lambda2_other.nc | U.: [-]
R.: map>0 | Pore size index (λ) layer 2 +| Lambda3 for forest and other | lambda2.nc | U.: [-]
R.: map>0 | Pore size index (λ) layer 3 | +| GenuAlpha1 for forest | alpha1_forest.nc | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1 | +| GenuAlpha1 for other | alpha1_other.nc | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 1 | +| GenuAlpha2 for forest | alpha2_forest.nc | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 2 | +| GenuAlpha2 for other | alpha2_other.nc | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 2 | +| GenuAlpha3 for forest and other | alpha2.nc | U.: $\frac{1} {cm}$
R.: 0 < map < 1 | Van Genuchten parameter α layer 3 | +| KSat1 for forest | ksat1_forest.nc | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1 | +| KSat1 for other | ksat1_other.nc | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 1 | +| KSat2 for forest | ksat2_forest.nc | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 2 | +| KSat2 for other | ksat2_other.nc | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 2 | +| KSat3 for forest and other | ksat3.nc | U.: $\frac{mm} {day}$
R.: map>0 | Saturated conductivity layer 3 | +| **CHANNEL GEOMETRY** | | | | +| Channels | chan.nc | U.: [-]
R.: 0 or 1 | Map with Boolean 1 for all channel pixels, and Boolean 0 for all other pixels on MaskMap | +| ChanGrad | changrad.nc | U.: $\frac{m} {m}$
R.: map > 0
!!! | Channel gradient | +| ChanMan | chanman.nc | U.: $m^{-1/3} s$
R.: map > 0 | Manning's roughness coefficient for channels | +| ChanLength | chanleng.nc | U.: $m$
R.: map > 0 | Channel length (can exceed grid size, to account for meandering rivers) | +| ChanBottomWidth | chanbw.nc | U.: $m$
R.: map > 0 | Channel bottom width | +| ChanSdXdY | chans.nc | U.: $\frac{m} {m}$
R.: map ≥ 0 | Channel side slope Important: defined as horizontal divided by vertical distance (dx/dy); this may be confusing because slope is usually defined the other way round (i.e. dy/dx)! | +| ChanDepthThreshold | chanbnkf.nc | U.: $m$
R.: map > 0 | Bankfull channel depth | +| **METEOROLOGICAL VARIABLES** | | | | +| PrecipitationMaps | pr | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Precipitation rate | +| TavgMaps | ta | U.: $°C$
R.:-50 ≤map ≤ +50 or U.: $K$ | Average temperature | +| E0Maps | e | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evaporation rate, free water surface | +| ES0Maps | es | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evaporation rate, bare soil | +| ET0Maps | et | U.: $\frac{mm} {day}$
R.: map ≥ 0 | Daily potential evapotranspiration rate, reference crop | +| **DEVELOPMENT OF VEGETATION OVER TIME** | | | | +| LAIMaps for forest | lai_forest | U.: $\frac{m^2} {m^2}$
R.: map ≥ 0 | Pixel-average Leaf Area Index for forest | +| LAIMaps for other | lai_other | U.: $\frac{m^2} {m^2}$
R.: map ≥ 0 | Pixel-average Leaf Area Index for other | +| LAIMaps for irrigation | lai_irrigation | U.: $\frac{m^2} {m^2}$
R.: map ≥ 0 | Pixel-average Leaf Area Index for irrigated areas | +| **DEFINITION OF INPUT/OUTPUT TIMESERIES** | | | | +| Gauges | outlets.nc | U.: [-]
R.: For each station an individual number | Nominal map with locations at which discharge timeseries are reported (usually correspond to gauging stations) | + + + + +***Table:*** Maps that define grid size, always required when uisng geographic (lat/lon) coordinate system.* + +| Map | Default name | Units, range | Description | +| --------------- | ------------ | ------------------------ | --------------------- | +| PixelLengthUser | pixleng.nc | U.: $m$
R.: map > 0 | Map with pixel length | +| PixelAreaUser | pixarea.nc | U.: $m$
R.: map > 0 | Map with pixel area | + + + +[🔝](#top) + diff --git a/docs/4_annex_output-files/index.md b/docs/5_annex_output-files/index.md similarity index 100% rename from docs/4_annex_output-files/index.md rename to docs/5_annex_output-files/index.md diff --git a/docs/4_annex_parameters/index.md b/docs/5_annex_parameters/index.md similarity index 100% rename from docs/4_annex_parameters/index.md rename to docs/5_annex_parameters/index.md diff --git a/docs/4_annex_settings_and_options/index.md b/docs/5_annex_settings_and_options/index.md similarity index 100% rename from docs/4_annex_settings_and_options/index.md rename to docs/5_annex_settings_and_options/index.md diff --git a/docs/5_annex_settings_and_options/index_v1.md b/docs/5_annex_settings_and_options/index_v1.md new file mode 100644 index 00000000..cf23383b --- /dev/null +++ b/docs/5_annex_settings_and_options/index_v1.md @@ -0,0 +1,577 @@ +This annex presents a nearly comprehensive list of setting options, inputs, and outputs. + +The content is organized in the following tables: + +- [**lfoptions**](../4_annex_settings_and_options/index.md#table-lfoptions-section-in-os-lisflood-settings-xml): list of available switches to activate optional modules and optional outputs (time series and map formats) +- [**luser**](../4_annex_settings_and_options/index.md#table-lfuser-in-os-lisflood-settings-xml): list of variables which are generally defined by the users. +- [**lfbinding**](../4_annex_settings_and_options/index.md#table-lfbinging-section-in-os-lisflood-settings-xml): list of model variables. +- [**initial variables**](../4_annex_settings_and_options/index.md#table-variables-required-for-model-initialization): list of variables required for model initialization. The table indicates values/maps required by the cold and warm start of both prerun and run) + + +## **Table:** *lfoptions section in OS LISFLOOD settings xml* + +The table below presents the ist of available switches to activate optional modules and optional outputs (time series and map formats). For each option, 1 = ON; 0 = OFF. Deault staus is 0 = OFF, unless otherwise indicated in the table. + +| section (XML) | module | KEY | Type | I/O | Description | +|:------------------------|:-------------------------------------------|:----------------------------------------|:--------------------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfoptions | SETTINGS | TemperatureInKelvin | switch (1 or 0) | | Use temperature data in C (=0) or in K (=1) | +| lfoptions | SETTINGS | gridSizeUserDefined | switch (1 or 0) | | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | +| lfoptions | INFLOW | inflow | switch (1 or 0) | | Use inflow hydrographs | +| lfoptions | SOIL | simulatePF | switch (1 or 0) | | Calculate pF values from soil moisture | +| lfoptions | LAKES | simulateLakes | switch (1 or 0) | | Simulate unregulated lakes | +| lfoptions | RESERVOIRS | simulateReservoirs | switch (1 or 0) | | Simulate reservoirs | +| lfoptions | LANDUSE CHANGE | TransientLandUseChange | switch (1 or 0) | | Activate reading of time changing land use description | +| lfoptions | WATER ABSTRACTION | TransientWaterDemandChange | switch (1 or 0) | | Activate reading of time changing water demand | +| lfoptions | WATER ABSTRACTION | useWaterDemandAveYear | switch (1 or 0) | | Use "average" year for water demand and loop it over years | +| lfoptions | TRANSMISSION LOSS | TransLoss | switch (1 or 0) | | Activate transmission loss | +| lfoptions | DOUBLE KINEMATIC WAVE | SplitRouting | switch (1 or 0) | | Activate double kinematic wave routing | +| lfoptions | MCT DIFFUSIVE WAVE | MCTRouting | switch (1 or 0) | | Activate MCT diffusive wave routing | +| lfoptions | WATER ABSTRACTION | wateruse | switch (1 or 0) | | Activate water use computation | +| lfoptions | GROUNDWATER | groundwaterSmooth | switch (1 or 0) | | Activate smoothing for groundwater | +| lfoptions | WATER ABSTRACTION | wateruseRegion | switch (1 or 0) | | Use water regions in water use module | +| lfoptions | IRRIGATION | drainedIrrigation | switch (1 or 0) | | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | +| lfoptions | IRRIGATION | riceIrrigation | switch (1 or 0) | | Activate computation for paddy rice irrigation and abstraction | +| lfoptions | EVAPO | openwaterevapo | switch (1 or 0, default = 1) | | Compute evaporation from open water | +| lfoptions | INDICATOR | indicator | switch (1 or 0) | | Activate computation of indicators (such as WEI, e-flow, etc) | +| lfoptions | SETTINGS | InitLisflood | switch (1 or 0) | | Run LISFLOOD initialization run | +| lfoptions | SETTINGS | InitLisfloodwithoutSplit | switch (1 or 0) | | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | +| lfoptions | SETTINGS | ColdStart | switch (1 or 0, default = 1) | | Run LISFLOOD Cold Start | +| lfoptions | IO | readNetcdfStack | switch (1 or 0) | | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | +| lfoptions | IO | writeNetcdfStack | switch (1 or 0) | | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | +| lfoptions | IO | writeNetcdf | switch (1 or 0) | | Write NetCDF files for END files (single netcdf) | +| lfoptions | DISCHARGE | repDischargeTs | switch (1 or 0, default = 1) rep tss | output | Report discharge time series at gauges | +| lfoptions | LOG | repMBTs | switch (1 or 0) rep tss | output | Report timeseries of absolute cumulative mass balance error | +| lfoptions | STATE | repStateSites | switch (1 or 0) rep tss | output | Report state variables at sites | +| lfoptions | STATE | repRateSites | switch (1 or 0) rep tss | output | Report state variables rates at sites | +| lfoptions | STATE | repStateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model variables, averaged over contributing area of each gauging station | +| lfoptions | STATE | repRateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model rate variables, averaged over contributing area of each gauging station | +| lfoptions | METEO | repMeteoUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of meteo input data | +| lfoptions | WATER ABSTRACTION | repwateruseGauges | switch (1 or 0) rep tss | output | Report water use ts at gauges | +| lfoptions | WATER ABSTRACTION | repwateruseSites | switch (1 or 0) rep tss | output | Report water use ts at sistes | +| lfoptions | SOIL | repPFUpsGauges | switch (1 or 0) rep tss | output | Report PF ts at gauges | +| lfoptions | SOIL | repPFSites | switch (1 or 0) rep tss | output | Report PF ts at sistes | +| lfoptions | LAKES | repsimulateLakes | switch (1 or 0) rep tss | output | Report time series of lakes | +| lfoptions | RESERVOIRS | repsimulateReservoirs | switch (1 or 0) rep tss | output | Report time series of reservoirs | +| lfoptions | LOG | repBal1 | switch (1 or 0) rep tss | output | Report water balance TS | +| lfoptions | STATE | repStateMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (as defined by "ReportSteps" variable) | +| lfoptions | STATE | repEndMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (at last time step) | +| lfoptions | METEO | repPrecipitationMaps | switch (1 or 0) rep maps | output | Report precipitation | +| lfoptions | METEO | repTavgMaps | switch (1 or 0) rep maps | output | Report average temperature maps | +| lfoptions | EVAPO | repETRefMaps | switch (1 or 0) rep maps | output | Report reference evapo-transpiration | +| lfoptions | EVAPO | repESRefMaps | switch (1 or 0) rep maps | output | Report reference soil evaporation | +| lfoptions | EVAPO | repEWRefMaps | switch (1 or 0) rep maps | output | Report reference evaporation of intercepted water | +| lfoptions | ROUTING | repChanCrossSectionMaps | switch (1 or 0) rep maps | output | Report total cross-section area for channels | +| lfoptions | INTERCEPTION | repCumInterCeptionMaps | switch (1 or 0) rep maps | output | Report cumulative interception | +| lfoptions | DISCHARGE | repDischargeMaps | switch (1 or 0) rep maps | output | Report maps of discharge (for each time step) | +| lfoptions | METEO | repDSLRMaps | switch (1 or 0) rep maps | output | Report maps with number of days since the last rainfall event | +| lfoptions | EVAPO | repESActMaps | switch (1 or 0) rep maps | output | Report actual soil evaporation | +| lfoptions | EVAPO | repEWIntMaps | switch (1 or 0) rep maps | output | Report evaporation of intercepted water | +| lfoptions | SNOW | repFrostIndexMaps | switch (1 or 0) rep maps | output | Report frost index maps | +| lfoptions | GROUNDWATER | repGwLossMaps | switch (1 or 0) rep maps | output | Report groundwater loss maps and trransmission loss maps (the later if the module TransLoss is active) | +| lfoptions | GROUNDWATER | repGwPercUZLZMaps | switch (1 or 0) rep maps | output | Report maps of percolation from upper to lower ground water zone (for each time step) | +| lfoptions | INFILTRATION | repInfiltrationMaps | switch (1 or 0) rep maps | output | Report infiltration maps | +| lfoptions | INTERCEPTION | repInterceptionMaps | switch (1 or 0) rep maps | output | Report interception maps | +| lfoptions | LEAF | repLeafDrainageMaps | switch (1 or 0) rep maps | output | Report leaf drainage maps | +| lfoptions | GROUNDWATER | repLZAvInflowMap | switch (1 or 0) rep maps | output | Report lower groundwater zone inflow maps | +| lfoptions | GROUNDWATER | repLZMaps | switch (1 or 0) rep maps | output | Report maps of lower groundwater zone storage (for each time step) | +| lfoptions | GROUNDWATER | repLZOutflowMaps | switch (1 or 0) rep maps | output | Report lower groundwater zone outflow maps | +| lfoptions | PERCOLATION | repPercolationMaps | switch (1 or 0) rep maps | output | Report percolation maps | +| lfoptions | SOIL | repPFMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture | +| lfoptions | SOIL | repPFForestMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture for forest fraction | +| lfoptions | SOIL | repPrefFlowMaps | switch (1 or 0) rep maps | output | Report preferential flow (rapid bypass soil matrix) | +| lfoptions | METEO | repRainMaps | switch (1 or 0) rep maps | output | Report rain excluding snow | +| lfoptions | GROUNDWATER | repSeepSubToGWMaps | switch (1 or 0) rep maps | output | Report flux between sub soil and GW | +| lfoptions | SNOW | repSnowCoverMaps | switch (1 or 0) rep maps | output | Report maps of snow cover (for each time step) | +| lfoptions | SNOW | repSnowMaps | switch (1 or 0) rep maps | output | Report maps of snow (for each time step) | +| lfoptions | SNOW | repSnowMeltMaps | switch (1 or 0) rep maps | output | Report maps of snowmelt (for each time step) | +| lfoptions | SURFACE | repSurfaceRunoffMaps | switch (1 or 0) rep maps | output | Report maps of surface runoff (for each time step) | +| lfoptions | TRANSPIRATION | repTaMaps | switch (1 or 0) rep maps | output | Report transpiration maps | +| lfoptions | SOIL | repThetaMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA | +| lfoptions | SOIL | repThetaForestMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA FOREST | +| lfoptions | SOIL | repThetaIrrigationMaps | switch (1 or 0) rep maps | output | Report irrigation mapsrE | +| lfoptions | SOIL | repTotalRunoffMaps | switch (1 or 0) rep maps | output | Report total runoff | +| lfoptions | GROUNDWATER | repUZMaps | switch (1 or 0) rep maps | output | Report maps of upper groundwater zone storage (for each time step) | +| lfoptions | GROUNDWATER | repUZOutflowMaps | switch (1 or 0) rep maps | output | Report maps for upper groundwater zone outflow | +| lfoptions | ROUTING | repWaterDepthMaps | switch (1 or 0) rep maps | output | Report water depth on soil surface | +| lfoptions | EVAPO | ETActMaps | switch (1 or 0) rep maps | output | Report actual evapo-transpiration | +| lfoptions | ROUTING | repFastRunoffMaps | switch (1 or 0) rep maps | output | Report fast runoff = surface + UZ | +| lfoptions | WATER STRESS | repRWS | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP | +| lfoptions | WATER STRESS | repStressDays | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP for forest | +| lfoptions | SOIL | repPF1Maps | switch (1 or 0) rep maps | output | Report PF1 maps | +| lfoptions | SOIL | repPF2Maps | switch (1 or 0) rep maps | output | Report PF2 maps | +| lfoptions | WATER ABSTRACTION | repTotalAbs | switch (1 or 0) rep maps | output | Report total water abstraction | +| lfoptions | WATER ABSTRACTION | repTotalWUse | switch (1 or 0) rep maps | output | Report total water use | +| lfoptions | INDICATOR | repWIndex | switch (1 or 0) rep maps | output | Report indexes and indicators | + + + + +## **Table:** *lfuser in OS LISFLOOD settings xml* + + +| section (XML) | module | KEY | Type | I/O | Description | +|:------------------------|:-------------------------------------------|:-------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfuser | SETTINGS | PathRoot | path | input | Root directory | +| lfuser | SETTINGS | MaskMap | map | input | Computation area for Lisflood model | +| lfuser | SETTINGS | Gauges | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) or lat lon (lat2 lon2 ...) | +| lfuser | SETTINGS | netCDFtemplate | map | input | netcdf template used to copy metadata information for writing netcdf $(PathEvapo)/$(PrefixE0) | +| lfuser | SETTINGS | CalendarDayStart | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | +| lfuser | SETTINGS | DtSec | value | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | +| lfuser | SETTINGS | DtSecChannel | value | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | +| lfuser | SETTINGS | StepStart | value/date | input | Step id number or date of the simulation start step. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | +| lfuser | SETTINGS | StepEnd | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | +| lfuser | SETTINGS | ReportSteps | value | input | Time steps at which to write model state maps. Use: #,#,# to specify single step numbers ; #..# to print all state files between one step and another one "endtime" to print state files for final step (to state file in NetCDF file format stack) | +| lfuser | SETTINGS | NumDaysSpinUp | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | +| lfuser | SETTINGS | NetCDFTimeChunks | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | +| lfuser | SETTINGS | MapsCaching | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | +| lfuser | SETTINGS | OutputMapsChunks | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | +| lfuser | SETTINGS | OutputMapsDataType | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | +| lfuser | GROUNDWATER | UpperZoneTimeConstant | value/map | input calib par | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | +| lfuser | GROUNDWATER | LowerZoneTimeConstant | value/map | input calib par | Time constant for the lower groundwater zone [days] This is the average time a water 'particle' remains in the reservoir if we had a stationary system (average inflow=average outflow) default: 100 | +| lfuser | GROUNDWATER | GwPercValue | value/map | input calib par | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | +| lfuser | GROUNDWATER | GwLoss | value/map | input calib par | Rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. A value of 0 (closed lower boundary) is recommended as a starting value; default: 0.0 | +| lfuser | GROUNDWATER | LZThreshold | value/map | input calib par | threshold value below which there is no outflow to the channel | +| lfuser | INFILTRATION | b_Xinanjiang | value/map | input calib par | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | +| lfuser | INFILTRATION | PowerPrefFlow | value/map | input calib par | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | +| lfuser | KINEMATIC WAVE | CalChanMan | value/map | input calib par | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | +| lfuser | SNOW | SnowMeltCoef | value/map | input calib par | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | +| lfuser | DOUBLE KINEMATIC WAVE | CalChanMan2 | value/map | input calib par | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | +| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | +| lfuser | MCT DIFFUSIVE WAVE | CalChanMan3 | value/map | input calib par | Multiplier [-] applied to Channel Manning's n for MCT diffusive wave routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | +| lfuser | LAKES | LakeMultiplier | value/map | input calib par | Multiplier applied to the lake parameter A | +| lfuser | RESERVOIRS | ReservoirFloodStorage | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | +| lfuser | RESERVOIRS | ReservoirFloodOutflowFactor | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | +| lfuser | TRANSMISSION LOSSES | TransSub | value/map | input calib par | Transmission loss function parameter | +| lfuser | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | +| lfuser | SETTINGS | AvWaterRateThreshold | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] . Default: 5.0 (not included in calibration) | +| lfuser | SETTINGS | PathOut | path | input | Directory where all output files are written. It must be an existing directory (if not you will get an error message). | +| lfuser | SETTINGS | PathInit | path | input | Path of the initial value maps e.g. lzavin.map (org=$(PathRoot)/outPo) It is the directory where the initial files are located, to initialize a “warm” start. It can be also the PathOut directory. | +| lfuser | SETTINGS | PathMaps | path | input | Maps path it is the directory where all input base maps are located | +| lfuser | INFLOW | PathInflow | path | input | Inflow path | +| lfuser | SETTINGS | PathParams | path | input | Calibration parameter path | +| lfuser | TABLE | PathTables | path | input | Tables path | +| lfuser | TABLE | PathMapsTables | path | input | Legacy terminology: path to folder where input maps are stored (some of these input maps used to be tables in legacy versions of the code) | +| lfuser | SOIL | PathSoilHyd | path | input | Maps instead tables for soil hydraulics path Directory where the soil hydraulic property maps are located | +| lfuser | LANDUSE | PathMapsLandUseChange | path | input | Maps for transient land use changes every 5 years | +| lfuser | LANDUSE | PathMapsLanduse | path | input | Maps for land use fractions and related land use maps | +| lfuser | WATER USE | PathWaterUse | path | input | Water use maps path | +| lfuser | METEO | PathMeteo | path | input | Meteo path Directory where all maps with meteorological input are located (rain, evapo(transpi)ration, temperature) | +| lfuser | LAI | PathLAI | path | input | Leaf Area Index maps path Directory where you Leaf Area Index maps are located | +| lfuser | SETTINGS | timestepInit | value/date | input initial | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". It is generally one step back compared to StepStart). timestepInit is ignored if netCDF file is a single netCDF file.. | +| lfuser | SURFACE | OFDirectInitValue | value/map | input initial/internal | Initial water volume for direct fraction on catchment surface [m3] | +| lfuser | SURFACE | OFOtherInitValue | value/map | input initial/internal | Initial water volume for other fraction on catchment surface [m3] | +| lfuser | SURFACE | OFForestInitValue | value/map | input initial/internal | Initial water volume for forest fraction on catchment surface [m3] | +| lfuser | SNOW | SnowCoverAInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone A [mm] | +| lfuser | SNOW | SnowCoverBInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone B [mm] | +| lfuser | SNOW | SnowCoverCInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone C [mm] | +| lfuser | SNOW | FrostIndexInitValue | value/map | input initial/internal | initial Frost Index value [C day-1] | +| lfuser | INTERCEPTION | CumIntInitValue | value/map | input initial/internal | cumulative interception [mm] Initial interception storage | +| lfuser | GROUNDWATER | UZInitValue | value/map | input initial/internal | It is the initial storage in the upper groundwater zone [mm] , other fraction | +| lfuser | SOIL | DSLRInitValue | value/map | input initial/internal | initial number of days since the last rainfall event [days], , other fraction | +| lfuser | GROUNDWATER | LZInitValue | value/map | input initial/internal | It is the initial storage in the lower groundwater zone [mm] -9999: use steady-state storage | +| lfuser | KINEMATIC WAVE | TotalCrossSectionAreaInitValue | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull It is the initial cross-sectional area [m2] of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). | +| lfuser | SOIL | ThetaInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the supercificial soil layer. Other fraction. | +| lfuser | SOIL | ThetaInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the upper soil layer. Other fraction. | +| lfuser | SOIL | ThetaInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the lower soil layer. Other fraction. | +| lfuser | DOUBLE KINEMATIC WAVE | CrossSection2AreaInitValue | value/map | input initial/internal | initial channel cross-sectional area [m2] of the water in the river channels for 2nd routing channel -9999: use 0 | +| lfuser | DOUBLE KINEMATIC WAVE | PrevSideflowInitValue | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| lfuser | MCT DIFFUSIVE WAVE | PrevCmMCTInitValue | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| lfuser | MCT DIFFUSIVE WAVE | PrevDmMCTInitValue | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| lfuser | LAKES | LakeInitialLevelValue | value/map | input initial/internal | Initial lake level [m] -9999 sets initial value to steady-state level | +| lfuser | KINEMATIC WAVE | PrevDischarge | value/map | input initial/internal | initial discharge from previous run only needed for MCT diffusive routing -9999: use 0 It is the initial discharge from previous run [m3s-1] used for MCT diffusive routing. Note that PrevDischarge is the instantaneous discharge referred to the end of the time step. | +| lfuser | KINEMATIC WAVE | PrevDischargeAvg | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only -9999: use 0 It is the initial discharge from previous run [m3s-1] used for lakes, reservoirs and transmission loss Note that PrevDischargeAvg is the average discharge for the last routing sub-step. | +| lfuser | INTERCEPTION | CumIntForestInitValue | value/map | input initial/internal | cumulative interception forest [mm] | +| lfuser | GROUNDWATER | UZForestInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | +| lfuser | SOIL | DSLRForestInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | +| lfuser | SOIL | ThetaForestInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values Forest fraction | +| lfuser | SOIL | ThetaForestInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values Forest fraction | +| lfuser | SOIL | ThetaForestInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values Forest fraction | +| lfuser | INTERCEPTION | CumIntIrrigationInitValue | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| lfuser | GROUNDWATER | UZIrrigationInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | +| lfuser | SOIL | DSLRIrrigationInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | +| lfuser | SOIL | ThetaIrrigationInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 for irrigation -9999: use field capacity values Irrigated fraction | +| lfuser | SOIL | ThetaIrrigationInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values Irrigated fraction | +| lfuser | SOIL | ThetaIrrigationInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 for irrigation -9999: use field capacity values Irrigated fraction | +| lfuser | SOIL | CumIntSealedInitValue | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| lfuser | SOIL | cumSeepTopToSubBOtherEnd | map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | SOIL | cumSeepTopToSubBForestEnd | map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | SOIL | cumSeepTopToSubBIrrigatedEnd | map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | GROUNDWATER | CumQEnd | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfuser | GROUNDWATER | TimeSinceStartPrerunChunkEnd | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | +| lfuser | GROUNDWATER | LZInflowCumEnd | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfuser | METEO | PrefixPrecipitation | prefix | input forcings | prefix precipitation maps | +| lfuser | METEO | PrefixTavg | prefix | input forcings | prefix average temperature maps | +| lfuser | EVAPO | PrefixE0 | prefix | input forcings | prefix E0 (potential open water evaporation) maps | +| lfuser | EVAPO | PrefixES0 | prefix | input forcings | prefix ES0 (potential open bare-soil evaporation)maps | +| lfuser | EVAPO | PrefixET0 | prefix | input forcings | prefix ET0 (potential reference evapotranspioration) maps | +| lfuser | LAI | PrefixLAIOther | prefix | input forcings | prefix LAI (Leaf Area Index) maps | +| lfuser | LAI | PrefixLAIForest | prefix | input forcings | prefix LAI forest maps | +| lfuser | LAI | PrefixLAIIrrigation | prefix | input forcings | prefix LAI irrigation maps | +| lfuser | WATER USE | PrefixWaterUseDomestic | prefix | input forcings | prefix domestic water use maps | +| lfuser | WATER USE | PrefixWaterUseLivestock | prefix | input forcings | prefix livestock water use maps | +| lfuser | WATER USE | PrefixWaterUseEnergy | prefix | input forcings | prefix energy water use maps | +| lfuser | WATER USE | PrefixWaterUseIndustry | prefix | input forcings | prefix industry water use maps | +| lfuser | METEO | PrScaling | value | input par | Multiplier applied to potential precipitation rates. Default = 1.0, not used in calibration. | +| lfuser | EVAPO | CalEvaporation | value | input par | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | +| lfuser | LEAF DRAINAGE | LeafDrainageTimeConstant | value | input par | Time constant for water in interception store [days] . Default = 1.0 | +| lfuser | EVAPO | kdf | value | input par | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | +| lfuser | DEPRESSION STORAGE | SMaxSealed | value | input par | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] . This storage is emptied by evaporation (EW0). Default = 1.0 | +| lfuser | SNOW | SnowFactor | value | input par | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | +| lfuser | SNOW | SnowSeasonAdj | value | input par | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | +| lfuser | SNOW | TempMelt | value | input par | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | +| lfuser | SNOW | TempSnow | value | input par | It is the average temperature below which precipitation is assumed to be snow [°C] | +| lfuser | SNOW | TemperatureLapseRate | value | input par | Temperature lapse rate with altitude [deg C / m]. It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1]. Default = 0.0065 | +| lfuser | SNOW | Afrost | value | input par | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. Default = 0.97 | +| lfuser | SNOW | Kfrost | value | input par | Snow depth reduction coefficient, [cm-1]. Default = 0.57 | +| lfuser | SNOW | SnowWaterEquivalent | value | input par | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | +| lfuser | SNOW | FrostIndexThreshold | value | input par | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | +| lfuser | WATER ABSTRACTION | IrrigationEfficiency | value/map | input | Field application irrigation efficiency max 1, ~0.90 drip irrigation, ~0.75 sprinkling | +| lfuser | WATER ABSTRACTION | ConveyanceEfficiency | value/map | input | onveyance efficiency, around 0.80 for average channel | +| lfuser | WATER ABSTRACTION | IrrigationType | value | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | +| lfuser | WATER ABSTRACTION | IrrigationMult | value | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | +| lfuser | WATER ABSTRACTION | LivestockConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | +| lfuser | WATER ABSTRACTION | IndustryConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | +| lfuser | WATER ABSTRACTION | EnergyConsumptiveUseFraction | value/map | input | Consumptive Use (1-Recycling ratio) for energy water use (0-1) Source: Torcellini et al. (2003) "Consumptive Use for US Power Production" map advised by Neil Edwards, Energy Industry the UK and small French rivers the consumptive use varies between 1:2 and 1:3, so 0.33-0.50 For plants along big rivers like Rhine and Danube the 0.025 is ok EnergyConsumptiveUseFraction=0.025 | +| lfuser | WATER ABSTRACTION | DomesticConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | +| lfuser | WATER ABSTRACTION | LeakageFraction | value | input | $(PathMaps)/leakage.map Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | +| lfuser | WATER ABSTRACTION | LeakageWaterLoss | value | input | The water that is lost from leakage (lost) (0-1) | +| lfuser | WATER ABSTRACTION | LeakageReductionFraction | value | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | +| lfuser | WATER ABSTRACTION | WaterSavingFraction | value | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | +| lfuser | CALC INDICATOR | Population | map | input | Population per pixel | +| lfuser | CALC INDICATOR | PopulationMaps | map | input | Population map for TransientLandUseChange | +| lfuser | CALC INDICATOR | LandUseMask | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | +| lfuser | WATER ABSTRACTION | WaterUseMaps | map | output | path and prefix of the reported water use m3 s-1 as a result of demand and availability | +| lfuser | WATER ABSTRACTION | WaterUseTS | tss | output | Time series of upstream water use at gauging stations | +| lfuser | WATER ABSTRACTION | StepsWaterUseTS | tss | output | number of loops needed for water use routine | +| lfuser | WATER ABSTRACTION | maxNoWateruse | value | input | maximum number of loops for calculating the use of water | +| lfuser | WATER ABSTRACTION | WUsePercRemain | value | input | percentage of water that must remain the channel (after water abstraction) | +| lfuser | WATER ABSTRACTION / CALC INDICATOR | WUseRegion | map | input | area from which surface water is extracted | +| lfuser | GROUNDWATER | LZSmoothRange | value | input | length of the window used to smooth the LZ zone [number of cell length] It works ONLY if wateruse=1 | +| lfuser | GROUNDWATER | GroundwaterBodies | map | input | map of aquifers (0/1), used to smoothen LZ near extraction areas | +| lfuser | LAKES | LakeMask | map | input | Mask with Lakes from GLWD database | +| lfuser | TRANSMISSION | TransPower1 | value | input par | Transmission loss function parameter. Default = 2.0 | +| lfuser | TRANSMISSION | TransArea | value | input par | downstream area taking into account for transmission loss | +| lfuser | TRANSMISSION / RESERVOIR | UpAreaTrans | map | inpput | upstream area for transmission loss and computation of K coeff in reservoirs module | +| lfuser | KINEMATIC WAVE | beta | value | input par | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | +| lfuser | KINEMATIC WAVE | OFDepRef | value | input par | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | +| lfuser | KINEMATIC WAVE | GradMin | value | input par | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | +| lfuser | KINEMATIC WAVE | ChanGradMin | value | input par | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | +| lfuser | MCT DIFFUSIVE WAVE | ChannelsMCT | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | +| lfuser | MCT DIFFUSIVE WAVE | ChanGradMaxMCT | value | input par | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) [m m-1] | +| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value | input par | PBchange Multiplier applied to average Q to split into a second line of routing | +| lfuser | SOIL | CourantCrit | value | input par | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | +| lfuser | RESERVOIRS | DtSecReservoirs | value | input | Sub time step used for reservoir simulation [s]. Within the model, the smallest out of DtSecReservoirs and DtSec is used. | +| lfuser | RESERVOIRS | ReservoirInitialFillValue | value/map | input initial/internal | Initial reservoir fill fraction -9999 sets initial fill to normal storage limit if you're not using the reservoir option, enter some bogus value | +| lfuser | LAKES | TabLakeAvNetInflowEstimate | table | input | Estimate of average net inflow into lake (=inflow - evaporation) [cu m / s] Used to calculated steady-state lake level in case LakeInitialLevelValue is set to -9999 | +| lfuser | INFLOW | InflowPoints | map | input forcings | OPTIONAL: nominal map with locations of (measured) inflow hydrographs [cu m / s] | +| lfuser | INFLOW | QInTS | tss | input forcings | OPTIONAL: observed or simulated input hydrographs as time series [cu m / s] Note that identifiers in time series correspond to InflowPoints map (also optional) | +| lfuser | SOIL | HeadMax | value | input | Maximum capillary head [cm]. This value is used if Theta equals residual soil moisture content (value of HeadMax is arbitrary). Only needed for pF computation, otherwise doesn't influence model results at all) | +| lfuser | EVAPORATION FROM OPEN WATER | maxNoEva | 10 | value | input | + + +## **Table:** *lfbinging section in OS LISFLOOD settings xml* + +| section (XML) | module | KEY | settings | Type | I/O | Description | +|:------------------------|:---------------------------------------------------------------|:-------------------------------------------|:------------------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfbinding | SNOW AND FROST | Afrost | $(Afrost) | value | input | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | +| lfbinding | INITIAL CONDITION | AvgDis | $(PathInit)/avgdis.map | map | input initial/internal | $(PathInit)/avgdis.map CHANNEL split routing in two lines Average discharge map [m3/s] | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | AvWaterRateThreshold | $(AvWaterRateThreshold) | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | +| lfbinding | INFILTRATION | b_Xinanjiang | $(b_Xinanjiang) | map | input | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | +| lfbinding | ROUTING | beta | $(beta) | 0 | input | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | +| lfbinding | ROUTING | CalChanMan | $(CalChanMan) | 0 | input | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | +| lfbinding | ROUTING | CalChanMan2 | $(CalChanMan2) | value/map | input | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | +| lfbinding | ROUTING | CalChanMan3 | $(CalChanMan3) | value/map | input | Multiplier [-] applied to Channel Manning's n for MCT routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | +| lfbinding | TIMESTEP RELATED PARAMETERS | CalendarDayStart | $(CalendarDayStart) | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | CalEvaporation | $(CalEvaporation) | value | input | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChanCrossSectionEnd | $(PathOut)/chcro.end | map | output/end | Reported chan cross-section area [m2] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanCrossSectionState | $(PathOut)/chcro | map | output/state | Reported chan cross-section area [m2] | +| lbinding | ROUTING | ChanGradMaxMCT | $(ChanGradMaxMCT) | map | input | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) | +| lfbinding | ROUTING | ChanGradMin | $(ChanGradMin) | nan | input | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | +| lbinding | ROUTING | ChannelsMCT | $(ChannelsMCT) | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQAvgDtEnd | $(PathOut)/chanqavgdt.end | map | output/end | Reported average discharge on the last routing sub-step [cu m/s] ChanQAvgDt | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQAvgDtState | $(PathOut)/chanqavgdt | map | output/state | Reported average discharge the last routing sub-step [cu m/s] ChanQAvgDt | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQEnd | $(PathOut)/chanq.end | map | output/end | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQState | $(PathOut)/chanq | map | output/state | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | +| lfbinding | REPORTED OUTPUT MAPS (END) | ChSideEnd | $(PathOut)/chside.end | map | output/end | Reported channel side flow | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChSideState | $(PathOut)/chside | map | output/state | Reported sideflow to channel for first line of routing [m3/s] | +| lfbinding | WATER USE MAPS AND PAR | ConveyanceEfficiency | $(ConveyanceEfficiency) | map | input | onveyance efficiency, around 0.80 for average channel | +| lfbinding | NUMERICS | CourantCrit | $(CourantCrit) | value | input | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | +| lfbinding | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | input initial/internal | initial channel crosssection for 2nd routing channel -9999: use 0 | +| lfbinding | REPORTED OUTPUT MAPS (END) | CrossSection2End | $(PathOut)/ch2cr.end | map | output/end | Cross section area for split routing [m2] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CrossSection2State | $(PathOut)/ch2cr | map | output/state | Cross section area for split routing [m2] | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionEnd | $(PathOut)/cum.end | map | output/end | Reported interception storage | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionForestEnd | $(PathOut)/cumf.end | map | output/end | Reported interception storage for forest | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionForestState | $(PathOut)/cumf | map | output/state | Reported interception storage for forest | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionIrrigationEnd | $(PathOut)/cumi.end | map | output/end | Reported interception storage for irrigation | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionIrrigationState | $(PathOut)/cumi | map | output/state | Reported interception storage | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionState | $(PathOut)/cum | map | output/state | Reported interception storage | +| lfbinding | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | input initial/internal | cumulative interception forest [mm] | +| lfbinding | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | input initial/internal | cumulative interception [mm] | +| lfbinding | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | CumIntSealedEnd | $(PathOut)/cseal.end | map | output/end | Reported depression storage | +| lfbinding | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumIntSealedState | $(PathOut)/cseal | map | output/state | Reported depression storage | +| lfbinding | REPORTED OUTPUT MAPS (END) | DischargeEnd | $(PathOut)/dis.end | map | output/end | Reported average discharge on the model timestep [m3/s] | +| lfbinding | REPORTED OUTPUT MAPS | DischargeMaps | $(PathOut)/dis | map | output | Reported average discharge [cu m/s] (average over model timestep) | +| lfbinding | REPORTED OUTPUT MAPS | DisMaps | $(PathOut)/q | map (missing) | output | Reported discharge [cu m/s] at the end of a timestep | +| lfbinding | WATER USE MAPS AND PARAMETERS | DomesticConsumptiveUseFraction | $(DomesticConsumptiveUseFraction) | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | +| lfbinding | INPUT WATER USE MAPS AND PAR | DomesticDemandMaps | $(PathWaterUse)/$(PrefixWaterUseDomestic) | map | input | Domestic water abstraction daily maps [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | DSLREnd | $(PathOut)/dslr.end | map | output/end | Reported days since last rain | +| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRForestEnd | $(PathOut)/dslf.end | map | output/end | Reported days since last rain for forest | +| lfbinding | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRForestState | $(PathOut)/dslf | map | output/state | Reported days since last rain for forest | +| lfbinding | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | input initial/internal | days since last rainfall | +| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRIrrigationEnd | $(PathOut)/dsli.end | map | output/end | Reported days since last rain for irrigation | +| lfbinding | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRIrrigationState | $(PathOut)/dsli | map | output/state | Reported days since last rain irrigation | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | DSLRMaps | $(PathOut)/dslr | map | output | Reported days since last rain | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRState | $(PathOut)/dslr | map | output/state | Reported days since last rain [ndays] | +| lfbinding | TIMESTEP RELATED PARAMETERS | DtSec | $(DtSec) | map | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | +| lfbinding | TIMESTEP RELATED PARAMETERS | DtSecChannel | $(DtSecChannel) | map | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | +| lfbinding | INPUT METEO AND VEG MAPS | E0Maps | $(PathMeteo)/$(PrefixE0) | map | input | daily reference evaporation (free water) [mm/day] | +| lfbinding | WATER USE MAPS AND PARAMETERS | EnergyConsumptiveUseFraction | $(EnergyConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for energy production water use (0-1) | +| lfbinding | INPUT WATER USE MAPS AND PAR | EnergyDemandMaps | $(PathWaterUse)/$(PrefixWaterUseEnergy) | map | input | Energy water abstraction daily maps [mm] | +| lfbinding | INPUT METEO AND VEG MAPS | ES0Maps | $(PathMeteo)/$(PrefixES0) | map | input | daily reference evaporation (soil) [mm/day] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ESRefMapsOut | $(PathOut)/es | map | output | Potential evaporation from bare soil surface [mm per time step] | +| lfbinding | INPUT METEO AND VEG MAPS | ET0Maps | $(PathMeteo)/$(PrefixET0) | map | input | daily reference evapotranspiration (crop) [mm/day] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ETRefMapsOut | $(PathOut)/et | map | output | Potential reference evapotranspiration [mm per time step] | +| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenMaps | $(PathOut)/evaop | map (missing) | output | Reported evaporation from open water [mm] | +| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenTS | $(PathOut)/evaopenUps.tss | tss (missing) | output | Time series of upstream water evaporation from open water at gauging stations | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EWRefMapsOut | $(PathOut)/ew | map | output | Potential evaporation from open water surface [mm per time step] | +| lfbinding | EVAPORATION FROM OPEN WATER | FracMaxWater | $(FracMaxWater) | value | input | Percentage of maximum extend of water | +| lfbinding | REPORTED OUTPUT MAPS (END) | FrostIndexEnd | $(PathOut)/frost.end | map | output/end | Reported frost index | +| lfbinding | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | input initial/internal | initial frost index value | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | FrostIndexState | $(PathOut)/frost | map | output/state | Reported frost index | +| lfbinding | SNOW AND FROST | FrostIndexThreshold | $(FrostIndexThreshold) | map | input | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | +| lfbinding | ROUTING | GradMin | $(GradMin) | 0 | input | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | +| lfbinding | GROUNDWATER RELATED PAR | GwLoss | $(GwLoss) | map | input | Maximum loss rate out of Lower response box, expressed as a fraction of lower zone outflow. Fraction [-], range 0-1 A value of 0 (closed lower boundary) is recommended as a starting value Maximum rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. default: 0.0 | +| lfbinding | GROUNDWATER RELATED PAR | GwPercValue | $(GwPercValue) | map | input | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | +| lfbinding | INPUT WATER USE MAPS AND PAR | IndustrialDemandMaps | $(PathWaterUse)/$(PrefixWaterUseIndustry) | map | input | Industry water abstraction daily maps [mm] | +| lfbinding | WATER USE MAPS AND PARAMETERS | IndustryConsumptiveUseFraction | $(IndustryConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | +| lfbinding | WATER USE MAPS AND PAR | IrrigationEfficiency | $(IrrigationEfficiency) | map | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | +| lfbinding | WATER USE MAPS AND PAR | IrrigationMult | $(IrrigationMult) | map | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | +| lfbinding | WATER USE MAPS AND PAR | IrrigationType | $(IrrigationType) | map | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | kdf | $(kdf) | value | input | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | +| lfbinding | SNOW AND FROST | Kfrost | $(Kfrost) | map | input | Snow depth reduction coefficient, [cm-1] | +| lfbinding | INPUT METEO AND VEG MAPS | LAIForestMaps | $(PathLAI)/$(PrefixLAIForest) | map | input | leaf area index forest [m2/m2] | +| lfbinding | INPUT METEO AND VEG MAPS | LAIIrrigationMaps | $(PathLAI)/$(PrefixLAIIrrigation) | map | input | leaf area index irrigation [m2/m2] | +| lfbinding | INPUT METEO AND VEG MAPS | LAIOtherMaps | $(PathLAI)/$(PrefixLAIOther) | map | input | leaf area index [m2/m2] | +| lfbinding | REPORTED OUTPUT MAPS (END) | LakeLevelEnd | $(PathOut)/lakeh.end | map | output/end | Reported lake level | +| lfbinding | EVAPORATION FROM OPEN WATER | LakeMask | $(LakeMask) | map | input | Mask with Lakes from GLWD database | +| lfbinding | REPORTED OUTPUT MAPS (END) | LakeStorageM3 | $(PathOut)/lakest | map | output | Reported lake storage | +| lfbinding | WATER USE MAPS AND PAR | LandUseMask | $(LandUseMask) | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | LeafDrainageTimeConstant | $(LeafDrainageTimeConstant) | map | input | Time constant for leaf drainage | +| lfbinding | WATER USE MAPS AND PARAMETERS | LeakageFraction | $(LeakageFraction) | map | input | Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | +| lfbinding | WATER USE MAPS AND PAR | LeakageReductionFraction | $(LeakageReductionFraction) | map | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | +| lfbinding | WATER USE MAPS AND PAR | LeakageWaterLoss | $(LeakageWaterLoss) | 0 | input | The water that is lost from leakage (lost) (0-1) | +| lfbinding | IRRIGATION AND WATER ABSTRACTION | LivestockConsumptiveUseFraction | $(LivestockConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | +| lfbinding | INPUT WATER USE MAPS AND PAR | LivestockDemandMaps | $(PathWaterUse)/$(PrefixWaterUseLivestock) | map | input | Livestock water abstraction daily maps [mm] | +| lfbinding | GROUNDWATER RELATED PAR | LowerZoneTimeConstant | $(LowerZoneTimeConstant) | map | input | Time constant for the lower groundwater zone [days] | +| lfbinding | INITIAL CONDITION | LZAvInflowMap | $(PathInit)/lzavin.map | value/map | input initial/internal | $(PathInit)/lzavin.map Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | +| lfbinding | REPORTED OUTPUT MAPS (END) | LZEnd | $(PathOut)/lz.end | map | output/end | Reported storage in lower groundwater zone response box [mm] | +| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | input initial/internal | water in lower store [mm] -9999: use steady-state storage | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | LZMaps | $(PathOut)/lz | map | output | Reported storage in lower groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | LZState | $(PathOut)/lz | map | output/state | Reported storage in lower response box [mm] | +| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropCoef | $(PathMapsTables)/cropcoef_i.map | table | input | Irrigation crop coefficient | +| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropGroupNumber | $(PathMapsTables)/cropgrpn_i.map | table | input | Irrigation crop group number | +| lfbinding | REPORTED OUTPUT MAPS | MaskDischargeMaps | $(PathOut)/dism | map (missing) | output | Reported discharge [cu m/s] but cut by a discharge mask map | +| lfbinding | SETTINGS | MaskMap | $(MaskMap) | map/value | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | +| lfbinding | EVAPORATION FROM OPEN WATER | maxNoEva | $(maxNoEva) | value | input | Maximum number of loops for calculating evaporation (distance water is taken to satisfy the need of evaporation from open water). Default = 10 | +| lfbinding | WATER USE MAPS AND PAR | maxNoWateruse | $(maxNoWateruse) | value | input | maximum number of loops for calculating the use of water (=distance to the water demand cell) | +| lfbinding | SETTINGS | netCDFtemplate | $(netCDFtemplate) | map | input | netcdf template used to copy metadata information for writing netcdf | +| lfbinding | ROUTING | OFDepRef | $(OFDepRef) | 0 | input | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | +| lfbinding | REPORTED OUTPUT MAPS (END) | OFDirectEnd | $(PathOut)/ofdir.end | map | output/end | Reported water volume for direct fraction on catchment surface | +| lfbinding | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | input initial/internal | Reported water volume for direct fraction on catchment surface [m^3] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFDirectState | $(PathOut)/ofdir | map | output/state | Reported water volume for direct fraction on catchment surface [m3] | +| lfbinding | REPORTED OUTPUT MAPS (END) | OFForestEnd | $(PathOut)/offor.end | map | output/end | | +| lfbinding | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | input initial/internal | Reported water volume for other fraction on catchment surface [m^3] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFForestState | $(PathOut)/offor | map | output/state | Reported water volume for forest fraction on catchment surface [m3] | +| lfbinding | REPORTED OUTPUT MAPS (END) | OFOtherEnd | $(PathOut)/ofoth.end | map | output/end | | +| lfbinding | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | input initial/internal | Reported water volume for forest fraction on catchment surface [m^3] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFOtherState | $(PathOut)/ofoth | map | output/state | Reported water volume for other fraction on catchment surface [m3] | +| lfbinding | WATER USE MAPS AND PAR | Population | $(Population) | map | input | Population per pixel | +| lfbinding | WATER USE MAPS AND PAR | PopulationMaps | $(PopulationMaps) | map | input | Population map for TransientLandUseChange | +| lfbinding | INFILTRATION | PowerPrefFlow | $(PowerPrefFlow) | map | input | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | +| lfbinding | INPUT METEO AND VEG MAPS | PrecipitationMaps | $(PathMeteo)/$(PrefixPrecipitation) | map | input | precipitation [mm/day] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | PrecipitationMapsOut | $(PathOut)/pr | map | output | Precipitation [mm per time step] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTEnd | $(PathOut)/prevcm.end | map | output/end | Reported Courant number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTState | $(PathOut)/prevcm | map | output/state | Reported Courant number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | input initial/internal | initial discharge from previous run for MCT diffusive routing -9999: use 0 | +| lfbinding | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTEnd | $(PathOut)/prevdm.end | map | output/end | Reported Raynolds number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTState | $(PathOut)/prevdm | map | output/state | Reported Reynolds number at previous step for MCT routing | +| lfbinding | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | PrScaling | $(PrScaling) | value | input | Multiplier applied to potential precipitation rates | +| lfbinding | ROUTING | QSplitMult | $(QSplitMult) | value | input | PBchange Multiplier applied to average Q to split into a second line of routing | +| lfbinding | REPORTED OUTPUT MAPS (END) | ReservoirFillEnd | $(PathOut)/rsfil.end | map | output/end | Reported reservoir filling | +| lfbinding | RICE IRRIGATION | RiceFlooding | 10 | 0 | input | water amount in mm per day 10 mm for 10 days (total 10cm water) | +| lfbinding | RICE IRRIGATION | RiceHarvestDay1 | $(PathMapsTables)/riceharvestday1.map | map | input | map with starting day of the year | +| lfbinding | RICE IRRIGATION | RiceHarvestDay2 | $(PathMapsTables)/riceharvestday2.map | map | input | map with starting day of the year | +| lfbinding | RICE IRRIGATION | RicePercolation | 2 | 0 | input | FAO: percolation for heavy clay soils: PERC = 2 mm/day | +| lfbinding | RICE IRRIGATION | RicePlantingDay1 | $(PathMapsTables)/riceplantingday1.map | table | input | map with starting day of the year | +| lfbinding | RICE IRRIGATION | RicePlantingDay2 | $(PathMapsTables)/riceplantingday2.map | table | input | map with starting day of the year | +| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | SMaxSealed | $(SMaxSealed) | value | input | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] This storage is emptied by evaporation (EW0) | +| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverAEnd | $(PathOut)/scova.end | map | output/end | Reported snow cover in snow zone A [mm] | +| lfbinding | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | input initial/internal | initial snow depth in snow zone A [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverAState | $(PathOut)/scova | map | output/state | Reported snow cover in snow zone A [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverBEnd | $(PathOut)/scovb.end | map | output/end | Reported snow cover in snow zone B [mm] | +| lfbinding | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | input initial/internal | initial snow depth in snow zone B [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverBState | $(PathOut)/scovb | map | output/state | Reported snow cover in snow zone B [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverCEnd | $(PathOut)/scovc.end | map | output/end | Reported snow cover in snow zone C [mm] | +| lfbinding | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | input initial/internal | initial snow depth in snow zone C [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverCState | $(PathOut)/scovc | map | output/state | Reported snow cover in snow zone C [mm] | +| lfbinding | SNOW AND FROST | SnowFactor | $(SnowFactor) | 0 | input | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | +| lfbinding | SNOW AND FROST | SnowMeltCoef | $(SnowMeltCoef) | 0 | input | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | +| lfbinding | SNOW AND FROST | SnowSeasonAdj | $(SnowSeasonAdj) | 0 | input | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | +| lfbinding | SNOW AND FROST | SnowWaterEquivalent | $(SnowWaterEquivalent) | 0 | input | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | +| lfbinding | TIMESTEP RELATED PARAMETERS | StepEnd | $(StepEnd) | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | +| lfbinding | TIMESTEP RELATED PARAMETERS | StepStart | $(StepStart) | value/date | input | Step id number or date of the simulation start step. See code for a list of available date formats. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | +| lfbinding | WATER USE MAPS AND PAR | StepsWaterUseTS | $(StepsWaterUseTS) | tss | input | number of loops needed for water use routine | +| lfbinding | REPORTED OUTPUT MAPS | SurfaceSoilMoistureMaps | $(PathOut)/wta | map (missing) | output | Reported surface soil moisture [%] | +| lfbinding | INPUT METEO AND VEG MAPS | TavgMaps | $(PathMeteo)/$(PrefixTavg) | map | input | average daily temperature [C] | +| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | TavgMapsOut | $(PathOut)/tav | map | output | Average DAILY temperature [degrees C] | +| lfbinding | SNOW AND FROST | TemperatureLapseRate | $(TemperatureLapseRate) | 0 | input | Temperature lapse rate with altitude [deg C / m] It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1] | +| lfbinding | SNOW AND FROST | TempMelt | $(TempMelt) | 0 | input | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | +| lfbinding | SNOW AND FROST | TempSnow | $(TempSnow) | 0 | input | It is the average temperature below which precipitation is assumed to be snow [°C] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1End | $(PathOut)/tha.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1ForestEnd | $(PathOut)/thfa.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a for forest [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1ForestState | $(PathOut)/thfa | map | output/state | theta for soil layer 1a forest fraction | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1IrrigationEnd | $(PathOut)/thia.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1IrrigationState | $(PathOut)/thia | map | output/state | Reported volumetric soil moisture content for soil layer 1a for irrigation[V/V] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta1Maps | $(PathOut)/thtop | map | output | Reported volumetric soil moisture content for soil layer 1 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1State | $(PathOut)/tha | map | output/state | Reported volumetric soil moisture content for soil layer 1 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2End | $(PathOut)/thb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2ForestEnd | $(PathOut)/thfb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b for forest [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2ForestState | $(PathOut)/thfb | map | output/state | theta for soil layer 1b forest fraction | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2IrrigationEnd | $(PathOut)/thib.end | map | output/end | Reported volumetric soil moisture content for soil layer 1b [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2IrrigationState | $(PathOut)/thib | map | output/state | Reported volumetric soil moisture content for both soil layer 1b for irrigation [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2State | $(PathOut)/thb | map | output/state | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3End | $(PathOut)/thc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3ForestEnd | $(PathOut)/thfc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3ForestState | $(PathOut)/thfc | map | output/state | theta for soil layer 2 forest fraction | +| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3IrrigationEnd | $(PathOut)/thic.end | map | output/end | Reported volumetric soil moisture content for soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3IrrigationState | $(PathOut)/thic | map | output/state | Reported volumetric soil moisture content for both soil layer 2 for irrigation [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta3Maps | $(PathOut)/thbot | map | output | Reported volumetric soil moisture content for soil layer 2 [V/V] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3State | $(PathOut)/thc | map | output/state | Reported volumetric soil moisture content for both soil layer 3 [V/V] | +| lfbinding | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a for irrigation -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b for irrigation -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values | +| lfbinding | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | input initial/internal | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | +| lfbinding | REPORTED OUTPUT MAPS | TopSoilMoistureMaps | $(PathOut)/wt | map (missing) | output | Reported Topsoil moisture [%] | +| lfbinding | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotalRunoffMaps | $(PathOut)/trun | map | output | Reported total runoff [mm/∆t] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotaltoChanMaps | $(PathOut)/ttoc | map | output | Reported total runoff that enters the channel: groundwater + surface runoff [mm/∆t] | +| lfbinding | TRANSMISSION LOSS | TransArea | $(TransArea) | 0 | input | PBchange downstream area taking into account for transmission loss | +| lfbinding | TRANSMISSION LOSS | TransPower1 | $(TransPower1) | 0 | input | PBchange Transmission loss function parameter | +| lfbinding | TRANSMISSION LOSS | TransSub | $(TransSub) | 0 | input | PBchange Transmission loss function parameter | +| lfbinding | TRANSMISSION LOSS | UpAreaTrans | $(UpAreaTrans) | 0 | input | upstream area for transmission loss | +| lfbinding | GROUNDWATER RELATED PAR | UpperZoneTimeConstant | $(UpperZoneTimeConstant) | map | input | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | +| lfbinding | REPORTED OUTPUT MAPS (END) | UZEnd | $(PathOut)/uz.end | map | output/end | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | UZForestEnd | $(PathOut)/uzf.end | map | output/end | Reported storage in upper groundwaterzone response box [mm] | +| lfbinding | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZForestState | $(PathOut)/uzf | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | input initial/internal | water in upper groundwater zone [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | UZIrrigationEnd | $(PathOut)/uzi.end | map | output/end | Reported storage in upper groundwater zone response box for irrigation [mm] | +| lfbinding | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZIrrigationState | $(PathOut)/uzi | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | UZMaps | $(PathOut)/uz | map | output | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | UZOutflowMaps | $(PathOut)/quz | map | output | Reported upper groundwater zone outflow [mm/∆t] | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZState | $(PathOut)/uz | map | output/state | Reported storage in upper groundwater zone response box [mm] | +| lfbinding | REPORTED OUTPUT MAPS (END) | WaterDepthEnd | $(PathOut)/wdept.end | map | output/end | Reported overlandflow water depth | +| lfbinding | OUPUT | WaterDepthInitValue | $(WaterDepthInitValue) | map | input | initial overland flow water depth [mm] | +| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | WaterDepthMaps | $(PathOut)/wdept | map | output | Reported water depth | +| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | WaterDepthState | $(PathOut)/wdept | map | output | Reported overland flow water depth | +| lfbinding | REPORTED OUTPUT MAPS | WaterLevelMaps | $(PathOut)/wl | map | output | Reported water level [m] | +| lfbinding | WATER USE MAPS AND PAR | WaterReUseFraction | $(WaterReUseFraction) | 0 | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | +| lfbinding | WATER USE MAPS AND PAR | WaterSavingFraction | $(WaterSavingFraction) | 0 | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | +| lfbinding | WATER USE MAPS AND PAR | WaterUseMaps | $(WaterUseMaps) | map | input | Reported water use m3 s-1 depending on the availability of discharge | +| lfbinding | WATER USE MAPS AND PAR | WaterUseTS | $(WaterUseTS) | tss | input | Time series of upstream water use at gauging stations | +| lfbinding | EVAPORATION FROM OPEN WATER | WFracOfDay | $(PathTables)/WFracOfDay.txt | map | input | table with days for each water use maps 1st column: range of days; 2nd column: suffix of wuse map | +| lfbinding | EVAPORATION FROM OPEN WATER | WFractionMaps | $(PathVarWaterfraction)/$(PrefixVarWaterFraction) | map | input | water use daily maps with a (in this case negative) volume of water [cu m/s] | +| lfbinding | WATER USE MAPS AND PAR | WUsePercRemain | $(WUsePercRemain) | value | input | percentage of water that must remain in a grid cell and is not withdrawn by water use e.g. 0.2 = 20 percent of discharge is not taken out | +| lfbinding | WATER USE MAPS AND PAR | WUseRegion | $(WUseRegion) | map | input | water use region | +| lfbinding | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | $(ChanBottomWMult) $(ChanDepthMult) $(ChanSMult) | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | +| lfbinding | INITIAL CONDITION | CumQEnd | $(CumQEnd) | map | output | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | CumQInit | $(CumQInit) | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestEnd | $(cumSeepTopToSubBForestEnd) | map | output | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationEnd | $(cumSeepTopToSubBIrrigationEnd) | map | output | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherEnd | $(cumSeepTopToSubBOtherEnd) | map | output | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfbinding | INITIAL CONDITION | LZInflowCumEnd | $(LZInflowCumEnd) | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | value/map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfbinding | SETTINGS | MapsCaching | $(MapsCaching) | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | +| lfbinding | SETTINGS | NetCDFTimeChunks | $(NetCDFTimeChunks) | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | +| lfbinding | SETTINGS | NumDaysSpinUp | $(NumDaysSpinUp) | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | +| lfbinding | SETTINGS | OutputMapsChunks | $(OutputMapsChunks) | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | +| lfbinding | SETTINGS | OutputMapsDataType | $(OutputMapsDataType) | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | +| lfbinding | DOUBLE KINEMATIC WAVE | QSplitMult | $(QSplitMult) | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | +| lfbinding | RESERVOIRS | ReservoirFloodOutflowFactor | $(ReservoirFloodOutflowFactor) | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | +| lfbinding | RESERVOIRS | ReservoirFloodStorage | $(ReservoirFloodStorage) | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | +| lfbinding | SOIL INIT | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | +| lfbinding | SOIL INIT | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | +| lfbinding | SOIL INIT | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkEnd | $(TimeSinceStartPrerunChunkEnd) | map | output | Cumulative discharge. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | + + + +## **Table:** *Variables required for model initialization.* + +| section (XML) | module | KEY | In settings xml | Type | Cold Start: prerun and run | Warm Start: preun | Warm Start: run | Description | +|:------------------------|:-------------------------------------------|:----------------------------------------|:----------------------------------------------|:-----------------------------|:---------------------------------------------------------------|:---------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfuser | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | -9999 | ch2cro.end.nc | ch2cro.end.nc | initial channel crosssection for 2nd routing channel -9999: use 0 | +| lfuser | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | 0 | cumf.end.nc | cumf.end.nc | cumulative interception forest [mm] | +| lfuser | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | 0 | cum.end.nc | cum.end.nc | cumulative interception [mm] | +| lfuser | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | 0 | cumi.end.nc | cumi.end.nc | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | +| lfuser | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | 0 | cseal.end.nc | cseal.end.nc | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | +| lfuser | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | 1 | dslf.end.nc | dslf.end.nc | initial number of days since the last rainfall event for forest [days] | +| lfuser | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | 1 | dslr.end.nc | dslr.end.nc | days since last rainfall | +| lfuser | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | 1 | dsli.end.nc | dsli.end.nc | initial number of days since the last rainfall event for irrigation [days] | +| lfuser | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | 0 | frost.end.nc | frost.end.nc | initial frost index value | +| lfuser | INITIAL CONDITION | LZAvInflowMap | $(PathMaps)/lzavin.map | value/map | run: lzavin.nc; prerun: not needed | Not needed | Not needed | Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | +| lfuser | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | 0 | ofdir.end.nc | ofdir.end.nc | Reported water volume for direct fraction on catchment surface [m^3] | +| lfuser | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | 0 | offor.end.nc | offor.end.nc | Reported water volume for other fraction on catchment surface [m^3] | +| lfuser | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | 0 | ofoth.end.nc | ofoth.end.nc | Reported water volume for forest fraction on catchment surface [m^3] | +| lfuser | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | -9999 | prevcm.end.nc | prevcm.end.nc | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | +| lfuser | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | -9999 | chanq.end.nc | chanq.end.nc | initial discharge from previous run for MCT diffusive routing -9999: use 0 | +| lfuser | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | -9999 | chanqavgdt.end.nc | chanqavgdt.end.nc | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | +| lfuser | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | -9999 | prevdm.end.nc | prevdm.end.nc | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | +| lfuser | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | -9999 | chside.end.nc | chside.end.nc | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | +| lfuser | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | 0 | scova.end.nc | scova.end.nc | initial snow depth in snow zone A [mm] | +| lfuser | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone B [mm] | +| lfuser | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone C [mm] | +| lfuser | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | thf1.end.nd, prerun outpit (preferred0); -9999 | thf1.end.nc | thf1.end.nc | initial soil moisture content layer 1, forest -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | thf2.end.nd, prerun outpit (preferred0); -9999 | thf2.end.nc | thf2.end.nc | initial soil moisture content layer 2, forest -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | thf3.end.nd, prerun outpit (preferred0); -9999 | thf3.end.nc | thf3.end.nc | initial soil moisture content layer 3, forest -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | th1.end.nd, prerun outpit (preferred0); -9999 | th1.end.nc | th1.end.nc | initial soil moisture content layer 1, other fraction -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | th2.end.nd, prerun outpit (preferred0); -9999 | th2.end.nc | th2.end.nc | initial soil moisture content layer 2, other fraction -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | th3.end.nd, prerun outpit (preferred0); -9999 | th3.end.nc | th3.end.nc | initial soil moisture content layer 3, other fraction -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | thi1.end.nd, prerun outpit (preferred0); -9999 | thi1.end.nc | thi1.end.nc | initial soil moisture content layer 1, irrigation -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | thi2.end.nd, prerun outpit (preferred0); -9999 | thi2.end.nc | thi2.end.nc | initial soil moisture content layer 2, irrigation -9999: use field capacity values | +| lfuser | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | thi3.end.nd, prerun outpit (preferred0); -9999 | thi3.end.nc | thi3.end.nc | initial soil moisture content layer 3, irrigation -9999: use field capacity values | +| lfuser | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | Not Needed | value/date | value/date | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | +| lfuser | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | -9999 | chcro.end.nc | chcro.end.nc | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | +| lfuser | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | 0 | uzf.end.nc | uzf.end.nc | Initial water storage water in upper groundwater zone for forest [mm] | +| lfuser | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | 0 | uz.end.nc | uz.end.nc | water in upper groundwater zone [mm] | +| lfuser | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | 0 | uzi.end.nc | uzi.end.nc | Initial water storage water in upper groundwater zone for irrigation [mm] | +| lfuser | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | 0 | cumSeepTopToSubBForest.end.nc | Not needed | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | 0 | cumSeepTopToSubBIrrigated.end.nc | Not needed | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | 0 | cumSeepTopToSubBOther.end.nc | Not needed | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | +| lfuser | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | map | 0 | LZInflowCum.end.nc | Not needed | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | +| lfuser | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | 0 | TimeSinceStartPrerunChunk.end.nc | Not needed | Cumulative discharge. Required for the warm start of the pre-run. | +| lfuser | INITIAL CONDITION | CumQInit | $(CumQInit) | map | 0 | CumQEnd.nc | Not needed | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | +| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | run: SeepTopToSubBAverageForestMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | run: SeepTopToSubBAverageIrrigationMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | run: SeepTopToSubBAverageOtherMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | +| lfbinding | INITIAL CONDITION | AvgDis | $(PathMaps)/avgdis.map | map | run: avgdis.nc; prerun: not needed | Not needed | Not needed | Reported map of average discharge (reported for end of simulation) | +| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | -9999 | lz.end.nc | lz.end.nc | water in lower store [mm] -9999: use steady-state storage | diff --git a/docs/4_annex_state-variables/index.md b/docs/5_annex_state-variables/index.md similarity index 100% rename from docs/4_annex_state-variables/index.md rename to docs/5_annex_state-variables/index.md diff --git a/docs/4_annex_tests/index.md b/docs/5_annex_tests/index.md similarity index 100% rename from docs/4_annex_tests/index.md rename to docs/5_annex_tests/index.md From 39d475e0939b203636346c2f8017a65d476b266e Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 16:52:58 +0200 Subject: [PATCH 60/70] remove duplicate file --- docs/_config.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index daf1f3d3..9d9d8412 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -246,18 +246,18 @@ defaults: - section_title: "Annex" items: - - title: "LISFLOOD input files" - url: 4_annex_input-files + - title: "LISFLOOD standard modules input maps " + url: 5_annex_input-maps-standard-modules - title: "LISFLOOD output files" - url: 4_annex_output-files + url: 5_annex_output-files - title: "LISFLOOD settings and options" - url: 4_annex_settings_and_options + url: 5_annex_settings_and_options - title: "LISFLOOD state variables" - url: 4_annex_state-variables + url: 5_annex_state-variables - title: "LISFLOOD parameters range and default values" - url: 4_annex_parameters + url: 5_annex_parameters - title: "LISFLOOD Tests documentation" - url: 4_annex_tests + url: 5_annex_tests - section_title: "Not to forget" items: From 5482118627966c94d541d9a61781d4ee97d7fe1f Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 17:02:01 +0200 Subject: [PATCH 61/70] small fixes annex input maps --- docs/5_annex_input-maps-standard-modules/index.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/5_annex_input-maps-standard-modules/index.md b/docs/5_annex_input-maps-standard-modules/index.md index d5cbd92c..98f90d0d 100644 --- a/docs/5_annex_input-maps-standard-modules/index.md +++ b/docs/5_annex_input-maps-standard-modules/index.md @@ -33,7 +33,7 @@ $ET0$, $EW0$ and $ES0$ can be calculated using standard meteorological observati ***Table:*** *LISFLOOD input maps.* -| Map | Default name | Units, range | Description | +| Map | Default name | Units, range (indicative) | Description | | --------------------------------------------------------- | ------------------- | ------------------------------------------------------ | ------------------------------------------------------------ | | **GENERAL** | | | | | MaskMap | area.nc | Unit: -
Range: 0 or 1 | Boolean map that defines model boundaries | @@ -49,14 +49,15 @@ $ET0$, $EW0$ and $ES0$ can be calculated using standard meteorological observati | Fraction of rice fields | fracrice.nc | U.:[-]
R.: 0 ≤ map ≤ 1 | Fraction for each cell dedicated to paddy rice crops. Values range from 0 to 1 | | Fraction of other land cover | fracother.nc | U.: [-]
R.: 0 ≤ map ≤ 1 | Other (non-forested natural area, pervious surface of urban areas, shrubs abd bushes, ...) fraction for each cell. | | **LAND COVER depending maps** | | | | -| Crop coef. for forest | cropcoef_forest.nc | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for forest | -| Crop coef. for other | cropcoef_other.nc | U.: [-]
R.: 0.8≤ map ≤ 1.2 | Crop coefficient for other | +| Crop coeff. for forest | cropcoef_forest.nc | U.: [-]
R.: 0.2≤ map ≤ 1.2 | Crop coefficient for forest | +| Crop coeff. for other | cropcoef_other.nc | U.: [-]
R.: 0.2≤ map ≤ 1.2 | Crop coefficient for other | +| Crop coeff. for irrigated areas | cropcoef_irr.nc | U.: [-]
R.: 0.2≤ map ≤ 1.2 | Crop coefficient for other | | Crop group number for forest | crgrnum_forest.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for forest | | Crop group number for forest | crgrnum_other.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for other | -| Crop group number for irrigation | crgrnum_irr.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for irrigation | -| Manning for forest | mannings_forest.nc | U.: $m^{-1/3} s$
R.: 0.2≤ map ≤ 0.4 | Manning's roughness for forest | -| Manning for other | mannings_other.nc | U.: $m^{-1/3} s$
R.: 0.01≤ map ≤0.3 | Manning's roughness for other | -| Manning for irrigation | mannings_irr.nc | U.: $m^{-1/3} s$
R.: 0.01≤ map ≤0.3 | Manning's roughness for irrigation | +| Crop group number for irrigated areas | crgrnum_irr.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for irrigation | +| Manning for forest | mannings_forest.nc | U.: $m^{1/3} s^{-1}$
R.: 0.015≤ map ≤ 0.4 | Manning's roughness for forest | +| Manning for other | mannings_other.nc | U.: $m^{1/3} s^{-1}$
R.: 0.015≤ map ≤0.4 | Manning's roughness for other | +| Manning for irrigation | mannings_irr.nc | U.: $m^{1/3} s^{-1}$
R.: 0.015≤ map ≤0.4 | Manning's roughness for irrigation | | Soil depth for forest for layer1 | soildepth1_forest.nc | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 1 | | Soil depth for other for layer1 | soildepth1_other.nc | U.: $mm$
R.: map ≥ 50 | Other soil depth for soil layer 1 | | Soil depth for forest for layer2 | soildepth2_forest.nc | U.: $mm$
R.: map ≥ 50 | Forest soil depth for soil layer 2 | From 70802bfc6e0dea92cf6a73a1a1288d37ae55fe15 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 17:03:22 +0200 Subject: [PATCH 62/70] remove duplicate file --- docs/5_annex_input-maps-standard-modules/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/5_annex_input-maps-standard-modules/index.md b/docs/5_annex_input-maps-standard-modules/index.md index 98f90d0d..8b3d6323 100644 --- a/docs/5_annex_input-maps-standard-modules/index.md +++ b/docs/5_annex_input-maps-standard-modules/index.md @@ -51,7 +51,7 @@ $ET0$, $EW0$ and $ES0$ can be calculated using standard meteorological observati | **LAND COVER depending maps** | | | | | Crop coeff. for forest | cropcoef_forest.nc | U.: [-]
R.: 0.2≤ map ≤ 1.2 | Crop coefficient for forest | | Crop coeff. for other | cropcoef_other.nc | U.: [-]
R.: 0.2≤ map ≤ 1.2 | Crop coefficient for other | -| Crop coeff. for irrigated areas | cropcoef_irr.nc | U.: [-]
R.: 0.2≤ map ≤ 1.2 | Crop coefficient for other | +| Crop coeff. for irrigated areas | cropcoef_irr.nc | U.: [-]
R.: 0.2≤ map ≤ 1.2 | Crop coefficient for irrigated areas | | Crop group number for forest | crgrnum_forest.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for forest | | Crop group number for forest | crgrnum_other.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for other | | Crop group number for irrigated areas | crgrnum_irr.nc | U.: [-]
R.: 1 ≤ map ≤ 5 | Crop group number for irrigation | From b3db094d8f0444158146c95e2673f1f52c0a1e57 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 18:07:22 +0200 Subject: [PATCH 63/70] add reference to papers and JRC Data Catalogue Datasets in intro to static maps --- docs/4_Static-Maps-introduction/index.md | 30 ++++++++++++++++++------ 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/4_Static-Maps-introduction/index.md b/docs/4_Static-Maps-introduction/index.md index e684c0d5..0310d793 100644 --- a/docs/4_Static-Maps-introduction/index.md +++ b/docs/4_Static-Maps-introduction/index.md @@ -1,8 +1,8 @@ -# USER GUIDE FOR THE CREATION OF THE INPUT MAP DATASET +# USER GUIDE FOR THE CREATION OF THE INPUT DATASET: MAPS and TABLES ## About this user guide -This user guide provides instructions and examples to create static maps required as an input for LISFLOOD hydrological model.
+This user guide provides instructions and examples to create static maps and text files (commonly referred to as 'tables') required as an input for LISFLOOD hydrological model.
The examples in this user guide have been derived from the generation of the static input maps for the European and Global Flood Awareness Systems (EFAS and GloFAS) of the Copernicus Emergency Management Service. Users are encouraged to create their own static maps for their region of interest and using local, national or any other type of source data. Possible data sources, used as examples in this user guide, are listed in the [Appendix](../4_Static-Maps_appendix).
Maps can be elaborated with any GIS/remote sensing software. Examples in this guide have been performed using CDO, GDAL, Python, and Google Earth Engine platform.
@@ -19,11 +19,27 @@ This user guide provides the examples for the European and Global domains that a + Ocean masked with NoData (except, pixel length and pixel area maps). -### Authors of the version compiled in May 2021 -Margarita Choulga, Francesca Moschini, Christel Prudhomme, Cinzia Mazzetti and ECMWF team +### Reference -#### Acknowledgements -The authors thank Juliana Disperati (JRC), Stefania Grimaldi (JRC), Peter Salamon (JRC) and Ad De Roo (JRC) for invaluable help with examining the upgraded static map and guidance throughout the work and preparation of this user guide; Dai Yamazaki (The University of Tokyo) and Emanuel Dutra (IPMA) for useful discussions and comments; Damien Decremer (ECMWF) for expert help with file transformation technical work.
-Margarita Choulga, Francesca Moschini, Christel Prudhomme, and Cinzia Mazzetti were funded by Copernicus Emergency Management Service – Early Warning Systems – operational computational centre of EFAS (CEMS-Flood) project which received funding from European Commission Copernicus Emergency Management Service (CEMS) Framework Contract No 198702 awarded to ECMWF. +Readers of this user guide are encouarged to cite the scinetific publications listed below. +- LISFLOOD Static Maps: Choulga, M., Moschini, F., Mazzetti, C., Grimaldi, S., Disperati, J., Beck, H., Salamon, P., and Prudhomme, C.: Technical note: Surface fields for global environmental modelling, Hydrol. Earth Syst. Sci., 28, 2991–3036, https://doi.org/10.5194/hess-28-2991-2024, 2024. +Nevertheless, it must be noted this user guide provides the most updated and complete documentation about the maps and tables required for the implementation of OS LISFLOOD simulations. +Users of OS LISFLOOD are encouraged to refer to this online documentation. Inaccuracies and errors can be reported by opening a [GitHub issue](https://github.com/ec-jrc/lisflood-code/issues). + +- Pan-European Meterological input data: Salamon, P., Sperzel, T., Gomes, G. R., Radke-Fretz, M., Lemke, C.-D., Russo, C., Schweim, C., Zsoter, E., Dosio, A., Vomero, M., Ziese, M., and Grimaldi, S.: EMO-1: an improved version of the high-resolution multi-variable gridded meteorological dataset for Europe, Earth Syst. Sci. Data Discuss. [preprint], https://doi.org/10.5194/essd-2025-723, in review, 2026 + + + +### Available data sets + +OS LISFLOOD static input maps and tables for the operational versions of the [Copernicus Emergency Management Service](https://emergency.copernicus.eu/) European and Global Flood Awareness System ([EFAS](https://european-flood.emergency.copernicus.eu/react/), [GloFAS](https://global-flood.emergency.copernicus.eu/react/)) can be downloaded from: + +- EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for Europe](https://data.jrc.ec.europa.eu/dataset/f572c443-7466-4adf-87aa-c0847a169f23) + +- EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for GloFAS] (https://publications.jrc.ec.europa.eu/repository/handle/JRC132801) + +The European Meteorological Observations (EMO) 1 arcmin-resolution, (sub-)daily, multi-variable gridded meteorological dataset includes precipitation, temperatuure, wind speed,solar radiation and water vapour pressure for the pan-European EFAS computational domain, and it can be downloaded from: + +- EC-JRC Data Catalogue, [EMO: A high-resolution multi-variable gridded meteorological data set for Europe](https://data.jrc.ec.europa.eu/dataset/0bd84be4-cec8-4180-97a6-8b3adaac4d26) \ No newline at end of file From e0763cb8b73de1f57abc450c99dba0cd3046507b Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 18:08:59 +0200 Subject: [PATCH 64/70] add reference to papers and JRC Data Catalogue Datasets in intro to static maps --- docs/4_Static-Maps-introduction/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/4_Static-Maps-introduction/index.md b/docs/4_Static-Maps-introduction/index.md index 0310d793..6e9b6ae7 100644 --- a/docs/4_Static-Maps-introduction/index.md +++ b/docs/4_Static-Maps-introduction/index.md @@ -19,7 +19,7 @@ This user guide provides the examples for the European and Global domains that a + Ocean masked with NoData (except, pixel length and pixel area maps). -### Reference +## References Readers of this user guide are encouarged to cite the scinetific publications listed below. @@ -32,13 +32,13 @@ Users of OS LISFLOOD are encouraged to refer to this online documentation. Inacc -### Available data sets +## Available datasets OS LISFLOOD static input maps and tables for the operational versions of the [Copernicus Emergency Management Service](https://emergency.copernicus.eu/) European and Global Flood Awareness System ([EFAS](https://european-flood.emergency.copernicus.eu/react/), [GloFAS](https://global-flood.emergency.copernicus.eu/react/)) can be downloaded from: - EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for Europe](https://data.jrc.ec.europa.eu/dataset/f572c443-7466-4adf-87aa-c0847a169f23) -- EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for GloFAS] (https://publications.jrc.ec.europa.eu/repository/handle/JRC132801) +- EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for GloFAS](https://publications.jrc.ec.europa.eu/repository/handle/JRC132801) The European Meteorological Observations (EMO) 1 arcmin-resolution, (sub-)daily, multi-variable gridded meteorological dataset includes precipitation, temperatuure, wind speed,solar radiation and water vapour pressure for the pan-European EFAS computational domain, and it can be downloaded from: From afed5dfb0a616bceb37c2306862b0867f3d666ad Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 14 May 2026 18:10:38 +0200 Subject: [PATCH 65/70] add reference to papers and JRC Data Catalogue Datasets in intro to static maps --- docs/4_Static-Maps-introduction/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/4_Static-Maps-introduction/index.md b/docs/4_Static-Maps-introduction/index.md index 6e9b6ae7..b80824c0 100644 --- a/docs/4_Static-Maps-introduction/index.md +++ b/docs/4_Static-Maps-introduction/index.md @@ -38,7 +38,7 @@ OS LISFLOOD static input maps and tables for the operational versions of the [Co - EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for Europe](https://data.jrc.ec.europa.eu/dataset/f572c443-7466-4adf-87aa-c0847a169f23) -- EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for GloFAS](https://publications.jrc.ec.europa.eu/repository/handle/JRC132801) +- EC-JRC Data Catalogue, [LISFLOOD static and parameter maps for GloFAS](https://data.jrc.ec.europa.eu/dataset/68050d73-9c06-499c-a441-dc5053cb0c86) The European Meteorological Observations (EMO) 1 arcmin-resolution, (sub-)daily, multi-variable gridded meteorological dataset includes precipitation, temperatuure, wind speed,solar radiation and water vapour pressure for the pan-European EFAS computational domain, and it can be downloaded from: From ed1be2948225743f95122455d5dad638409428d9 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Fri, 15 May 2026 11:25:03 +0200 Subject: [PATCH 66/70] remove not available outputs from annex-output-files --- docs/5_annex_output-files/index.md | 76 ++++++++++++++---------------- 1 file changed, 35 insertions(+), 41 deletions(-) diff --git a/docs/5_annex_output-files/index.md b/docs/5_annex_output-files/index.md index 6843e6e5..613fbe02 100644 --- a/docs/5_annex_output-files/index.md +++ b/docs/5_annex_output-files/index.md @@ -14,7 +14,6 @@ LISFLOOD can generate a wide variety of outputs. Output files can be time series | **NUMERICAL CHECKS** | | | | $^2$ cumulative mass balance error | $m^3$ | mbError.tss | | $^2$ cumulative mass balance error, expressed as mm water slice (average over catchment) | $mm$ | mbErrorMm.tss | -| $^2$ number of sub-steps needed for channel routing | - | NoSubStepsChannel.tss | $^1$ Output only if option 'InitLisflood' = 1 (pre-run) $^2$ Output only if option 'InitLisflood' = 0 @@ -32,35 +31,6 @@ Output time series can be classified in the following categories: | Description | Units | Settings variable | Default name | | ------------------------------------------------------------ | -------------------------- | ---------------------- | ---------------------- | -| **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 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 | -| frost index | $\frac{°C}{days}$ | FrostIndexTS | frost.tss | -| **RATE VARIABLES AT SITES** (option *repRateSites*) | | | | -| rain (excluding snow) | $\frac{mm}{timestep}$ | RainTS | rain.tss | -| Snow | $\frac{mm}{timestep}$ | SnowTS | snow.tss | -| snow melt | $\frac{mm}{timestep}$ | SnowmeltTS | snowMelt.tss | -| actual evaporation | $\frac{mm}{timestep}$ | ESActTS | esAct.tss | -| actual transpiration | $\frac{mm}{timestep}$ | TaTS | tAct.tss | -| rainfall interception | $\frac{mm}{timestep}$ | InterceptionTS | interception.tss | -| evaporation of intercepted water | $\frac{mm}{timestep}$ | EWIntTS | ewIntAct.tss | -| leaf drainage | $\frac{mm}{timestep}$ | LeafDrainageTS | leafDrainage.tss | -| infiltration | $\frac{mm}{timestep}$ | InfiltrationTS | infiltration.tss | -| preferential (bypass) flow | $\frac{mm}{timestep}$ | PrefFlowTS | prefFlow.tss | -| percolation upper to lower soil layer | $\frac{mm}{timestep}$ | PercolationTS | dTopToSub.tss | -| percolation lower soil layer to subsoil | $\frac{mm}{timestep}$ | SeepSubToGWTS | dSubToUz.tss | -| surface runoff | $\frac{mm}{timestep}$ | SurfaceRunoffTS | surfaceRunoff.tss | -| outflow from upper zone | $\frac{mm}{timestep}$ | UZOutflowTS | qUz.tss | -| outflow from lower zone | $\frac{mm}{timestep}$ | LZOutflowTS | qLz.tss | -| total runoff | $\frac{mm}{timestep}$ | TotalRunoffTS | totalRunoff.tss | -| percolation from upper to lower zone | $\frac{mm}{timestep}$ | GwPercUZLZTS | percUZLZ.tss | -| loss from lower zone | $\frac{mm}{timestep}$ | GwLossTS | loss.tss | | **TIME SERIES, AVERAGE UPSTREAM OF GAUGES** | | | | | **METEOROLOGICAL INPUT VARIABLES** (option *repMeteoUpsGauges*) | | | | | precipitation | $\frac{mm}{timestep}$ | PrecipitationAvUpsTS | precipUps.tss | @@ -98,11 +68,35 @@ Output time series can be classified in the following categories: | total runoff | $\frac{mm}{timestep}$ | TotalRunoffAvUpsTS | totalRunoffUps.tss | | percolation upper to lower zone | $\frac{mm}{timestep}$ | GwPercUZLZAvUpsTS | percUZLZUps.tss | | loss from lower zone | $\frac{mm}{timestep}$ | GwLossTS | lossUps.tss | -| **WATER LEVEL IN CHANNEL** (option *repWaterLevelTs*) | | | | -| water level in channel | $m$ (above channel bottom) | WaterLevelTS | waterLevel.tss | -| **OUTPUT RELATED TO LOWER ZONE INITIALISATION** (option *repLZAvInflowSites* and *repLZAvInflowUpsGauges*) | | | | -| average inflow into lower zone | $\frac{mm^3}{day}$ | LZAvInflowTS | lzAvIn.tss | -| average inflow into lower zone | $\frac{mm^3}{day}$ | LZAvInflowAvUpsTS | lzAvInUps.tss | +| **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 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 | +| frost index | $\frac{°C}{days}$ | FrostIndexTS | frost.tss | +| **RATE VARIABLES AT SITES** (option *repRateSites*) | | | | +| rain (excluding snow) | $\frac{mm}{timestep}$ | RainTS | rain.tss | +| Snow | $\frac{mm}{timestep}$ | SnowTS | snow.tss | +| snow melt | $\frac{mm}{timestep}$ | SnowmeltTS | snowMelt.tss | +| actual evaporation | $\frac{mm}{timestep}$ | ESActTS | esAct.tss | +| actual transpiration | $\frac{mm}{timestep}$ | TaTS | tAct.tss | +| rainfall interception | $\frac{mm}{timestep}$ | InterceptionTS | interception.tss | +| evaporation of intercepted water | $\frac{mm}{timestep}$ | EWIntTS | ewIntAct.tss | +| leaf drainage | $\frac{mm}{timestep}$ | LeafDrainageTS | leafDrainage.tss | +| infiltration | $\frac{mm}{timestep}$ | InfiltrationTS | infiltration.tss | +| preferential (bypass) flow | $\frac{mm}{timestep}$ | PrefFlowTS | prefFlow.tss | +| percolation upper to lower soil layer | $\frac{mm}{timestep}$ | PercolationTS | dTopToSub.tss | +| percolation lower soil layer to subsoil | $\frac{mm}{timestep}$ | SeepSubToGWTS | dSubToUz.tss | +| surface runoff | $\frac{mm}{timestep}$ | SurfaceRunoffTS | surfaceRunoff.tss | +| outflow from upper zone | $\frac{mm}{timestep}$ | UZOutflowTS | qUz.tss | +| outflow from lower zone | $\frac{mm}{timestep}$ | LZOutflowTS | qLz.tss | +| total runoff | $\frac{mm}{timestep}$ | TotalRunoffTS | totalRunoff.tss | +| percolation from upper to lower zone | $\frac{mm}{timestep}$ | GwPercUZLZTS | percUZLZ.tss | +| loss from lower zone | $\frac{mm}{timestep}$ | GwLossTS | loss.tss | @@ -121,7 +115,7 @@ In addition, some additional maps and time series may be reported for debugging Note 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. -***Table:*** *LISFLOOD initialization default output maps (Output only if option 'InitLisflood' = 1).* +***Table:*** *LISFLOOD initialization output maps (Output only if option 'InitLisflood' = 1).* | Description | Units | File name | Domain | | ------------------------------------------------------------ | ------------------- | ----------------- | ------------------------------------ | @@ -129,13 +123,13 @@ In addition, some additional maps and time series may be reported for debugging | average inflow to lower zone | $mm$ | lzavin.nc | whole pixel | | 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. +LISFLOOD can also generate 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, as well as maps of the average seppage flow from the second to the third soil layer. More details are provided in the chapter dedicated to [model initialization](../3_step4_model-initialisation). +To speed up the pre-run and to prevent that results are taken from the pre-run, non/necessary outputs are disabled if option 'InitLisflood' = 1 is chosen. -### *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 simultion (warm start).* 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/ . +The complete list of state maps is available here https://ec-jrc.github.io/lisflood-code/5_annex_state-variables/ . The users should be aware that some state maps are generated only if the relevant option has been set to 1. For instance, LakePrevInflowState and LakePrevOutflowState can be generated only when 'simulateLakes' = 1. @@ -152,7 +146,7 @@ The users should be aware that some state maps are generated only if the relevan | potential open water evaporation | repEWRefMaps | $mm$ | EWRefMaps | ew | | average daily temperature | repTavgMaps | $mm$ | TavgMaps | tav | | **VOLUME VARIABLES** | | | | | -| depth of water on soil surface | repWaterDepthMaps | $mm$ | WaterDepthMaps | wdep | +| depth of water on soil surface (overland flow) | repWaterDepthMaps | $mm$ | WaterDepthMaps | wdep | | depth of snow cover on soil surface | repSnowCoverMaps | $mm$ | SnowCoverMaps | scov | | depth of interception storage | repCumInterceptionMaps | $mm$ | CumInterceptionMaps (other fraction)
CumInterceptionForestMaps
CumInterceptionIrrigationMaps
CumIntSealedMaps | cum
cumf
cumi
cums | | soil moisture content of the three soil layers | repThetaMaps | $\frac{mm^3}{mm^3}$ | Theta1Maps
Theta1ForestMaps
Theta1IrrigationMaps
Theta2Maps
Theta2ForestMaps
Theta2IrrigationMaps
Theta3Maps
Theta3ForestMaps
Theta3IrrigationMaps | tha
thfa
thia
thb
thfb
thib
thc
thfc
thic| From eff645068efa84671e77b601aa3f7c69ed84faeb Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Fri, 22 May 2026 16:32:20 +0200 Subject: [PATCH 67/70] small corrections to 5_annex_output_files --- docs/5_annex_output-files/index.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/5_annex_output-files/index.md b/docs/5_annex_output-files/index.md index 613fbe02..a0f716a4 100644 --- a/docs/5_annex_output-files/index.md +++ b/docs/5_annex_output-files/index.md @@ -124,13 +124,7 @@ In addition, some additional maps and time series may be reported for debugging | average channel discharge (if option 'SplitRouting' = 1) | $\frac{m}{s}$ | avgdis.nc| channel | LISFLOOD can also generate 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, as well as maps of the average seppage flow from the second to the third soil layer. More details are provided in the chapter dedicated to [model initialization](../3_step4_model-initialisation). -To speed up the pre-run and to prevent that results are taken from the pre-run, non/necessary outputs are disabled if option 'InitLisflood' = 1 is chosen. - -### *LISFLOOD state maps. These maps can be used to define the initial conditions of another simultion (warm start).* -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/5_annex_state-variables/ . -The users should be aware that some state maps are generated only if the relevant option has been set to 1. For instance, LakePrevInflowState and LakePrevOutflowState can be generated only when 'simulateLakes' = 1. +To speed up the pre-run and to prevent that results are taken from the pre-run, not necessary outputs are disabled if option 'InitLisflood' = 1 is chosen. ***Table:*** *LISFLOOD optional output maps* @@ -175,6 +169,16 @@ The users should be aware that some state maps are generated only if the relevan | percolation upper to lower zone | repGwPercUZLZMaps | $\frac{mm}{timestep}$ | GwPercUZLZMaps
GwPercUZLZOtherMaps
GwPercUZLZForestMaps
GwPercUZLZIrrigationMaps | uz2lzPixel
uz2lz
uz2lzF
uz2lzi | | loss from lower zone | repGwLossMaps | $\frac{mm}{timestep}$ | GwLossMaps | loss | + +*LISFLOOD state maps* are the maps can be used to define the initial conditions of another simultion (warm start). 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/5_annex_state-variables/ . + +The users should be aware that some state maps are generated only if the relevant option has been set to 1. For instance, LakePrevInflowState and LakePrevOutflowState can be generated only when 'simulateLakes' = 1. + + + + **Note** Some cumulative stoarges and volumes are computed internally by LISFLOOD. Some relevant exmaple is described below: From 773e7a18f53acdcebe642b51d9b0cd8f03c2890c Mon Sep 17 00:00:00 2001 From: r3dmos <52637308+r3dmos@users.noreply.github.com> Date: Fri, 5 Jun 2026 18:40:19 +0200 Subject: [PATCH 68/70] Update temporal coverage for irrigated crops data --- docs/4_Static-Maps_leaf-area-index/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/4_Static-Maps_leaf-area-index/index.md b/docs/4_Static-Maps_leaf-area-index/index.md index 8c1aa083..c130475c 100644 --- a/docs/4_Static-Maps_leaf-area-index/index.md +++ b/docs/4_Static-Maps_leaf-area-index/index.md @@ -21,7 +21,7 @@ In LISFLOOD LAI has an important role in water interception and evapotranspirati | :---| :--- | :--- | :--- | | Copernicus Global Land Service LAI Collection Version 2 | https://land.copernicus.eu/global/products/lai | 1 January 2010 - 31 December 2019 | Global, 1 km| | Fraction of forest | It can be prepared by using [this methodology](../4_Static-Maps_land-use#fraction-of-forest)| NA | Global, 1' and 3'| -| Fraction of irrigated crops | It can be prepared by using [this methodology](../4_Static-Maps_land-use#fraction-of-irrigated-crops)| NA | Global, 1' and 3'| +| Fraction of irrigated crops | It can be prepared by using [this methodology](../4_Static-Maps_land-use#fraction-of-irrigated-crops)| 1 January 2010 - 31 December 2020 | Global, 1' and 3'| | Fraction of other land cover type | It can be prepared by using [this methodology](../4_Static-Maps_land-use#fraction-of-other-land-use-type)|NA | Global, 1' and 3'| #### Methodology From 14e2bf1353ff87144eb80a737414c57de1d4c463 Mon Sep 17 00:00:00 2001 From: StefaniaGrimaldi Date: Thu, 18 Jun 2026 16:09:20 +0200 Subject: [PATCH 69/70] remove outdated file --- docs/5_annex_settings_and_options/index_v1.md | 577 ------------------ 1 file changed, 577 deletions(-) delete mode 100644 docs/5_annex_settings_and_options/index_v1.md diff --git a/docs/5_annex_settings_and_options/index_v1.md b/docs/5_annex_settings_and_options/index_v1.md deleted file mode 100644 index cf23383b..00000000 --- a/docs/5_annex_settings_and_options/index_v1.md +++ /dev/null @@ -1,577 +0,0 @@ -This annex presents a nearly comprehensive list of setting options, inputs, and outputs. - -The content is organized in the following tables: - -- [**lfoptions**](../4_annex_settings_and_options/index.md#table-lfoptions-section-in-os-lisflood-settings-xml): list of available switches to activate optional modules and optional outputs (time series and map formats) -- [**luser**](../4_annex_settings_and_options/index.md#table-lfuser-in-os-lisflood-settings-xml): list of variables which are generally defined by the users. -- [**lfbinding**](../4_annex_settings_and_options/index.md#table-lfbinging-section-in-os-lisflood-settings-xml): list of model variables. -- [**initial variables**](../4_annex_settings_and_options/index.md#table-variables-required-for-model-initialization): list of variables required for model initialization. The table indicates values/maps required by the cold and warm start of both prerun and run) - - -## **Table:** *lfoptions section in OS LISFLOOD settings xml* - -The table below presents the ist of available switches to activate optional modules and optional outputs (time series and map formats). For each option, 1 = ON; 0 = OFF. Deault staus is 0 = OFF, unless otherwise indicated in the table. - -| section (XML) | module | KEY | Type | I/O | Description | -|:------------------------|:-------------------------------------------|:----------------------------------------|:--------------------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfoptions | SETTINGS | TemperatureInKelvin | switch (1 or 0) | | Use temperature data in C (=0) or in K (=1) | -| lfoptions | SETTINGS | gridSizeUserDefined | switch (1 or 0) | | Get grid size attributes (length, area) from user-defined maps (instead of using map location attributes directly) | -| lfoptions | INFLOW | inflow | switch (1 or 0) | | Use inflow hydrographs | -| lfoptions | SOIL | simulatePF | switch (1 or 0) | | Calculate pF values from soil moisture | -| lfoptions | LAKES | simulateLakes | switch (1 or 0) | | Simulate unregulated lakes | -| lfoptions | RESERVOIRS | simulateReservoirs | switch (1 or 0) | | Simulate reservoirs | -| lfoptions | LANDUSE CHANGE | TransientLandUseChange | switch (1 or 0) | | Activate reading of time changing land use description | -| lfoptions | WATER ABSTRACTION | TransientWaterDemandChange | switch (1 or 0) | | Activate reading of time changing water demand | -| lfoptions | WATER ABSTRACTION | useWaterDemandAveYear | switch (1 or 0) | | Use "average" year for water demand and loop it over years | -| lfoptions | TRANSMISSION LOSS | TransLoss | switch (1 or 0) | | Activate transmission loss | -| lfoptions | DOUBLE KINEMATIC WAVE | SplitRouting | switch (1 or 0) | | Activate double kinematic wave routing | -| lfoptions | MCT DIFFUSIVE WAVE | MCTRouting | switch (1 or 0) | | Activate MCT diffusive wave routing | -| lfoptions | WATER ABSTRACTION | wateruse | switch (1 or 0) | | Activate water use computation | -| lfoptions | GROUNDWATER | groundwaterSmooth | switch (1 or 0) | | Activate smoothing for groundwater | -| lfoptions | WATER ABSTRACTION | wateruseRegion | switch (1 or 0) | | Use water regions in water use module | -| lfoptions | IRRIGATION | drainedIrrigation | switch (1 or 0) | | Use map of drainage systems to determine return flow (if drained, all percolation to channel within day; if not, all normal soil processes) | -| lfoptions | IRRIGATION | riceIrrigation | switch (1 or 0) | | Activate computation for paddy rice irrigation and abstraction | -| lfoptions | EVAPO | openwaterevapo | switch (1 or 0, default = 1) | | Compute evaporation from open water | -| lfoptions | INDICATOR | indicator | switch (1 or 0) | | Activate computation of indicators (such as WEI, e-flow, etc) | -| lfoptions | SETTINGS | InitLisflood | switch (1 or 0) | | Run LISFLOOD initialization run | -| lfoptions | SETTINGS | InitLisfloodwithoutSplit | switch (1 or 0) | | Run LISFLOOD initialization run to compute Lzavin.map and skip completely the routing component | -| lfoptions | SETTINGS | ColdStart | switch (1 or 0, default = 1) | | Run LISFLOOD Cold Start | -| lfoptions | IO | readNetcdfStack | switch (1 or 0) | | Read meteorological data in NetCDF format (Precip, Tavg, ET0, E0,ES0) | -| lfoptions | IO | writeNetcdfStack | switch (1 or 0) | | Write NetCDF stacks for output files (the pr.nc is read to get the metadata like projection) | -| lfoptions | IO | writeNetcdf | switch (1 or 0) | | Write NetCDF files for END files (single netcdf) | -| lfoptions | DISCHARGE | repDischargeTs | switch (1 or 0, default = 1) rep tss | output | Report discharge time series at gauges | -| lfoptions | LOG | repMBTs | switch (1 or 0) rep tss | output | Report timeseries of absolute cumulative mass balance error | -| lfoptions | STATE | repStateSites | switch (1 or 0) rep tss | output | Report state variables at sites | -| lfoptions | STATE | repRateSites | switch (1 or 0) rep tss | output | Report state variables rates at sites | -| lfoptions | STATE | repStateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model variables, averaged over contributing area of each gauging station | -| lfoptions | STATE | repRateUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of model rate variables, averaged over contributing area of each gauging station | -| lfoptions | METEO | repMeteoUpsGauges | switch (1 or 0) rep tss | output | Report timeseries of meteo input data | -| lfoptions | WATER ABSTRACTION | repwateruseGauges | switch (1 or 0) rep tss | output | Report water use ts at gauges | -| lfoptions | WATER ABSTRACTION | repwateruseSites | switch (1 or 0) rep tss | output | Report water use ts at sistes | -| lfoptions | SOIL | repPFUpsGauges | switch (1 or 0) rep tss | output | Report PF ts at gauges | -| lfoptions | SOIL | repPFSites | switch (1 or 0) rep tss | output | Report PF ts at sistes | -| lfoptions | LAKES | repsimulateLakes | switch (1 or 0) rep tss | output | Report time series of lakes | -| lfoptions | RESERVOIRS | repsimulateReservoirs | switch (1 or 0) rep tss | output | Report time series of reservoirs | -| lfoptions | LOG | repBal1 | switch (1 or 0) rep tss | output | Report water balance TS | -| lfoptions | STATE | repStateMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (as defined by "ReportSteps" variable) | -| lfoptions | STATE | repEndMaps | switch (1 or 0, default =1) rep maps | output | Report maps of model state variables (at last time step) | -| lfoptions | METEO | repPrecipitationMaps | switch (1 or 0) rep maps | output | Report precipitation | -| lfoptions | METEO | repTavgMaps | switch (1 or 0) rep maps | output | Report average temperature maps | -| lfoptions | EVAPO | repETRefMaps | switch (1 or 0) rep maps | output | Report reference evapo-transpiration | -| lfoptions | EVAPO | repESRefMaps | switch (1 or 0) rep maps | output | Report reference soil evaporation | -| lfoptions | EVAPO | repEWRefMaps | switch (1 or 0) rep maps | output | Report reference evaporation of intercepted water | -| lfoptions | ROUTING | repChanCrossSectionMaps | switch (1 or 0) rep maps | output | Report total cross-section area for channels | -| lfoptions | INTERCEPTION | repCumInterCeptionMaps | switch (1 or 0) rep maps | output | Report cumulative interception | -| lfoptions | DISCHARGE | repDischargeMaps | switch (1 or 0) rep maps | output | Report maps of discharge (for each time step) | -| lfoptions | METEO | repDSLRMaps | switch (1 or 0) rep maps | output | Report maps with number of days since the last rainfall event | -| lfoptions | EVAPO | repESActMaps | switch (1 or 0) rep maps | output | Report actual soil evaporation | -| lfoptions | EVAPO | repEWIntMaps | switch (1 or 0) rep maps | output | Report evaporation of intercepted water | -| lfoptions | SNOW | repFrostIndexMaps | switch (1 or 0) rep maps | output | Report frost index maps | -| lfoptions | GROUNDWATER | repGwLossMaps | switch (1 or 0) rep maps | output | Report groundwater loss maps and trransmission loss maps (the later if the module TransLoss is active) | -| lfoptions | GROUNDWATER | repGwPercUZLZMaps | switch (1 or 0) rep maps | output | Report maps of percolation from upper to lower ground water zone (for each time step) | -| lfoptions | INFILTRATION | repInfiltrationMaps | switch (1 or 0) rep maps | output | Report infiltration maps | -| lfoptions | INTERCEPTION | repInterceptionMaps | switch (1 or 0) rep maps | output | Report interception maps | -| lfoptions | LEAF | repLeafDrainageMaps | switch (1 or 0) rep maps | output | Report leaf drainage maps | -| lfoptions | GROUNDWATER | repLZAvInflowMap | switch (1 or 0) rep maps | output | Report lower groundwater zone inflow maps | -| lfoptions | GROUNDWATER | repLZMaps | switch (1 or 0) rep maps | output | Report maps of lower groundwater zone storage (for each time step) | -| lfoptions | GROUNDWATER | repLZOutflowMaps | switch (1 or 0) rep maps | output | Report lower groundwater zone outflow maps | -| lfoptions | PERCOLATION | repPercolationMaps | switch (1 or 0) rep maps | output | Report percolation maps | -| lfoptions | SOIL | repPFMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture | -| lfoptions | SOIL | repPFForestMaps | switch (1 or 0) rep maps | output | Report pF and vegetation stress due to low soil moisture for forest fraction | -| lfoptions | SOIL | repPrefFlowMaps | switch (1 or 0) rep maps | output | Report preferential flow (rapid bypass soil matrix) | -| lfoptions | METEO | repRainMaps | switch (1 or 0) rep maps | output | Report rain excluding snow | -| lfoptions | GROUNDWATER | repSeepSubToGWMaps | switch (1 or 0) rep maps | output | Report flux between sub soil and GW | -| lfoptions | SNOW | repSnowCoverMaps | switch (1 or 0) rep maps | output | Report maps of snow cover (for each time step) | -| lfoptions | SNOW | repSnowMaps | switch (1 or 0) rep maps | output | Report maps of snow (for each time step) | -| lfoptions | SNOW | repSnowMeltMaps | switch (1 or 0) rep maps | output | Report maps of snowmelt (for each time step) | -| lfoptions | SURFACE | repSurfaceRunoffMaps | switch (1 or 0) rep maps | output | Report maps of surface runoff (for each time step) | -| lfoptions | TRANSPIRATION | repTaMaps | switch (1 or 0) rep maps | output | Report transpiration maps | -| lfoptions | SOIL | repThetaMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA | -| lfoptions | SOIL | repThetaForestMaps | switch (1 or 0) rep maps | output | Reporting of *individual* model state variables as maps THETA FOREST | -| lfoptions | SOIL | repThetaIrrigationMaps | switch (1 or 0) rep maps | output | Report irrigation mapsrE | -| lfoptions | SOIL | repTotalRunoffMaps | switch (1 or 0) rep maps | output | Report total runoff | -| lfoptions | GROUNDWATER | repUZMaps | switch (1 or 0) rep maps | output | Report maps of upper groundwater zone storage (for each time step) | -| lfoptions | GROUNDWATER | repUZOutflowMaps | switch (1 or 0) rep maps | output | Report maps for upper groundwater zone outflow | -| lfoptions | ROUTING | repWaterDepthMaps | switch (1 or 0) rep maps | output | Report water depth on soil surface | -| lfoptions | EVAPO | ETActMaps | switch (1 or 0) rep maps | output | Report actual evapo-transpiration | -| lfoptions | ROUTING | repFastRunoffMaps | switch (1 or 0) rep maps | output | Report fast runoff = surface + UZ | -| lfoptions | WATER STRESS | repRWS | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP | -| lfoptions | WATER STRESS | repStressDays | switch (1 or 0) rep maps | output | Report soil transpiration reduction factor RWP for forest | -| lfoptions | SOIL | repPF1Maps | switch (1 or 0) rep maps | output | Report PF1 maps | -| lfoptions | SOIL | repPF2Maps | switch (1 or 0) rep maps | output | Report PF2 maps | -| lfoptions | WATER ABSTRACTION | repTotalAbs | switch (1 or 0) rep maps | output | Report total water abstraction | -| lfoptions | WATER ABSTRACTION | repTotalWUse | switch (1 or 0) rep maps | output | Report total water use | -| lfoptions | INDICATOR | repWIndex | switch (1 or 0) rep maps | output | Report indexes and indicators | - - - - -## **Table:** *lfuser in OS LISFLOOD settings xml* - - -| section (XML) | module | KEY | Type | I/O | Description | -|:------------------------|:-------------------------------------------|:-------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfuser | SETTINGS | PathRoot | path | input | Root directory | -| lfuser | SETTINGS | MaskMap | map | input | Computation area for Lisflood model | -| lfuser | SETTINGS | Gauges | map | input | Nominal map with gauge locations (i.e cells for which simulated discharge is written to file(1,2,3 etc) or lat lon (lat2 lon2 ...) | -| lfuser | SETTINGS | netCDFtemplate | map | input | netcdf template used to copy metadata information for writing netcdf $(PathEvapo)/$(PrefixE0) | -| lfuser | SETTINGS | CalendarDayStart | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | -| lfuser | SETTINGS | DtSec | value | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | -| lfuser | SETTINGS | DtSecChannel | value | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | -| lfuser | SETTINGS | StepStart | value/date | input | Step id number or date of the simulation start step. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | -| lfuser | SETTINGS | StepEnd | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | -| lfuser | SETTINGS | ReportSteps | value | input | Time steps at which to write model state maps. Use: #,#,# to specify single step numbers ; #..# to print all state files between one step and another one "endtime" to print state files for final step (to state file in NetCDF file format stack) | -| lfuser | SETTINGS | NumDaysSpinUp | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | -| lfuser | SETTINGS | NetCDFTimeChunks | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | -| lfuser | SETTINGS | MapsCaching | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | -| lfuser | SETTINGS | OutputMapsChunks | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | -| lfuser | SETTINGS | OutputMapsDataType | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | -| lfuser | GROUNDWATER | UpperZoneTimeConstant | value/map | input calib par | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | -| lfuser | GROUNDWATER | LowerZoneTimeConstant | value/map | input calib par | Time constant for the lower groundwater zone [days] This is the average time a water 'particle' remains in the reservoir if we had a stationary system (average inflow=average outflow) default: 100 | -| lfuser | GROUNDWATER | GwPercValue | value/map | input calib par | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | -| lfuser | GROUNDWATER | GwLoss | value/map | input calib par | Rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. A value of 0 (closed lower boundary) is recommended as a starting value; default: 0.0 | -| lfuser | GROUNDWATER | LZThreshold | value/map | input calib par | threshold value below which there is no outflow to the channel | -| lfuser | INFILTRATION | b_Xinanjiang | value/map | input calib par | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | -| lfuser | INFILTRATION | PowerPrefFlow | value/map | input calib par | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | -| lfuser | KINEMATIC WAVE | CalChanMan | value/map | input calib par | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | -| lfuser | SNOW | SnowMeltCoef | value/map | input calib par | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | -| lfuser | DOUBLE KINEMATIC WAVE | CalChanMan2 | value/map | input calib par | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | -| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | -| lfuser | MCT DIFFUSIVE WAVE | CalChanMan3 | value/map | input calib par | Multiplier [-] applied to Channel Manning's n for MCT diffusive wave routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | -| lfuser | LAKES | LakeMultiplier | value/map | input calib par | Multiplier applied to the lake parameter A | -| lfuser | RESERVOIRS | ReservoirFloodStorage | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | -| lfuser | RESERVOIRS | ReservoirFloodOutflowFactor | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | -| lfuser | TRANSMISSION LOSSES | TransSub | value/map | input calib par | Transmission loss function parameter | -| lfuser | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | -| lfuser | SETTINGS | AvWaterRateThreshold | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] . Default: 5.0 (not included in calibration) | -| lfuser | SETTINGS | PathOut | path | input | Directory where all output files are written. It must be an existing directory (if not you will get an error message). | -| lfuser | SETTINGS | PathInit | path | input | Path of the initial value maps e.g. lzavin.map (org=$(PathRoot)/outPo) It is the directory where the initial files are located, to initialize a “warm” start. It can be also the PathOut directory. | -| lfuser | SETTINGS | PathMaps | path | input | Maps path it is the directory where all input base maps are located | -| lfuser | INFLOW | PathInflow | path | input | Inflow path | -| lfuser | SETTINGS | PathParams | path | input | Calibration parameter path | -| lfuser | TABLE | PathTables | path | input | Tables path | -| lfuser | TABLE | PathMapsTables | path | input | Legacy terminology: path to folder where input maps are stored (some of these input maps used to be tables in legacy versions of the code) | -| lfuser | SOIL | PathSoilHyd | path | input | Maps instead tables for soil hydraulics path Directory where the soil hydraulic property maps are located | -| lfuser | LANDUSE | PathMapsLandUseChange | path | input | Maps for transient land use changes every 5 years | -| lfuser | LANDUSE | PathMapsLanduse | path | input | Maps for land use fractions and related land use maps | -| lfuser | WATER USE | PathWaterUse | path | input | Water use maps path | -| lfuser | METEO | PathMeteo | path | input | Meteo path Directory where all maps with meteorological input are located (rain, evapo(transpi)ration, temperature) | -| lfuser | LAI | PathLAI | path | input | Leaf Area Index maps path Directory where you Leaf Area Index maps are located | -| lfuser | SETTINGS | timestepInit | value/date | input initial | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". It is generally one step back compared to StepStart). timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfuser | SURFACE | OFDirectInitValue | value/map | input initial/internal | Initial water volume for direct fraction on catchment surface [m3] | -| lfuser | SURFACE | OFOtherInitValue | value/map | input initial/internal | Initial water volume for other fraction on catchment surface [m3] | -| lfuser | SURFACE | OFForestInitValue | value/map | input initial/internal | Initial water volume for forest fraction on catchment surface [m3] | -| lfuser | SNOW | SnowCoverAInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone A [mm] | -| lfuser | SNOW | SnowCoverBInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone B [mm] | -| lfuser | SNOW | SnowCoverCInitValue | value/map | input initial/internal | It is the initial snow cover on the soil surface in elevation zone C [mm] | -| lfuser | SNOW | FrostIndexInitValue | value/map | input initial/internal | initial Frost Index value [C day-1] | -| lfuser | INTERCEPTION | CumIntInitValue | value/map | input initial/internal | cumulative interception [mm] Initial interception storage | -| lfuser | GROUNDWATER | UZInitValue | value/map | input initial/internal | It is the initial storage in the upper groundwater zone [mm] , other fraction | -| lfuser | SOIL | DSLRInitValue | value/map | input initial/internal | initial number of days since the last rainfall event [days], , other fraction | -| lfuser | GROUNDWATER | LZInitValue | value/map | input initial/internal | It is the initial storage in the lower groundwater zone [mm] -9999: use steady-state storage | -| lfuser | KINEMATIC WAVE | TotalCrossSectionAreaInitValue | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull It is the initial cross-sectional area [m2] of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). | -| lfuser | SOIL | ThetaInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the supercificial soil layer. Other fraction. | -| lfuser | SOIL | ThetaInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the upper soil layer. Other fraction. | -| lfuser | SOIL | ThetaInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values It is the initial moisture content [mm3 mm-3] of the lower soil layer. Other fraction. | -| lfuser | DOUBLE KINEMATIC WAVE | CrossSection2AreaInitValue | value/map | input initial/internal | initial channel cross-sectional area [m2] of the water in the river channels for 2nd routing channel -9999: use 0 | -| lfuser | DOUBLE KINEMATIC WAVE | PrevSideflowInitValue | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfuser | MCT DIFFUSIVE WAVE | PrevCmMCTInitValue | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfuser | MCT DIFFUSIVE WAVE | PrevDmMCTInitValue | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfuser | LAKES | LakeInitialLevelValue | value/map | input initial/internal | Initial lake level [m] -9999 sets initial value to steady-state level | -| lfuser | KINEMATIC WAVE | PrevDischarge | value/map | input initial/internal | initial discharge from previous run only needed for MCT diffusive routing -9999: use 0 It is the initial discharge from previous run [m3s-1] used for MCT diffusive routing. Note that PrevDischarge is the instantaneous discharge referred to the end of the time step. | -| lfuser | KINEMATIC WAVE | PrevDischargeAvg | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only -9999: use 0 It is the initial discharge from previous run [m3s-1] used for lakes, reservoirs and transmission loss Note that PrevDischargeAvg is the average discharge for the last routing sub-step. | -| lfuser | INTERCEPTION | CumIntForestInitValue | value/map | input initial/internal | cumulative interception forest [mm] | -| lfuser | GROUNDWATER | UZForestInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | -| lfuser | SOIL | DSLRForestInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | -| lfuser | SOIL | ThetaForestInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 -9999: use field capacity values Forest fraction | -| lfuser | SOIL | ThetaForestInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values Forest fraction | -| lfuser | SOIL | ThetaForestInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 -9999: use field capacity values Forest fraction | -| lfuser | INTERCEPTION | CumIntIrrigationInitValue | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfuser | GROUNDWATER | UZIrrigationInitValue | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfuser | SOIL | DSLRIrrigationInitValue | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | -| lfuser | SOIL | ThetaIrrigationInit1Value | value/map | input initial/internal | initial soil moisture content layer 1 for irrigation -9999: use field capacity values Irrigated fraction | -| lfuser | SOIL | ThetaIrrigationInit2Value | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values Irrigated fraction | -| lfuser | SOIL | ThetaIrrigationInit3Value | value/map | input initial/internal | initial soil moisture content layer 3 for irrigation -9999: use field capacity values Irrigated fraction | -| lfuser | SOIL | CumIntSealedInitValue | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfuser | SOIL | cumSeepTopToSubBOtherEnd | map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | SOIL | cumSeepTopToSubBForestEnd | map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | SOIL | cumSeepTopToSubBIrrigatedEnd | map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | GROUNDWATER | CumQEnd | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfuser | GROUNDWATER | TimeSinceStartPrerunChunkEnd | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | -| lfuser | GROUNDWATER | LZInflowCumEnd | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfuser | METEO | PrefixPrecipitation | prefix | input forcings | prefix precipitation maps | -| lfuser | METEO | PrefixTavg | prefix | input forcings | prefix average temperature maps | -| lfuser | EVAPO | PrefixE0 | prefix | input forcings | prefix E0 (potential open water evaporation) maps | -| lfuser | EVAPO | PrefixES0 | prefix | input forcings | prefix ES0 (potential open bare-soil evaporation)maps | -| lfuser | EVAPO | PrefixET0 | prefix | input forcings | prefix ET0 (potential reference evapotranspioration) maps | -| lfuser | LAI | PrefixLAIOther | prefix | input forcings | prefix LAI (Leaf Area Index) maps | -| lfuser | LAI | PrefixLAIForest | prefix | input forcings | prefix LAI forest maps | -| lfuser | LAI | PrefixLAIIrrigation | prefix | input forcings | prefix LAI irrigation maps | -| lfuser | WATER USE | PrefixWaterUseDomestic | prefix | input forcings | prefix domestic water use maps | -| lfuser | WATER USE | PrefixWaterUseLivestock | prefix | input forcings | prefix livestock water use maps | -| lfuser | WATER USE | PrefixWaterUseEnergy | prefix | input forcings | prefix energy water use maps | -| lfuser | WATER USE | PrefixWaterUseIndustry | prefix | input forcings | prefix industry water use maps | -| lfuser | METEO | PrScaling | value | input par | Multiplier applied to potential precipitation rates. Default = 1.0, not used in calibration. | -| lfuser | EVAPO | CalEvaporation | value | input par | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | -| lfuser | LEAF DRAINAGE | LeafDrainageTimeConstant | value | input par | Time constant for water in interception store [days] . Default = 1.0 | -| lfuser | EVAPO | kdf | value | input par | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | -| lfuser | DEPRESSION STORAGE | SMaxSealed | value | input par | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] . This storage is emptied by evaporation (EW0). Default = 1.0 | -| lfuser | SNOW | SnowFactor | value | input par | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | -| lfuser | SNOW | SnowSeasonAdj | value | input par | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | -| lfuser | SNOW | TempMelt | value | input par | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | -| lfuser | SNOW | TempSnow | value | input par | It is the average temperature below which precipitation is assumed to be snow [°C] | -| lfuser | SNOW | TemperatureLapseRate | value | input par | Temperature lapse rate with altitude [deg C / m]. It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1]. Default = 0.0065 | -| lfuser | SNOW | Afrost | value | input par | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. Default = 0.97 | -| lfuser | SNOW | Kfrost | value | input par | Snow depth reduction coefficient, [cm-1]. Default = 0.57 | -| lfuser | SNOW | SnowWaterEquivalent | value | input par | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | -| lfuser | SNOW | FrostIndexThreshold | value | input par | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | -| lfuser | WATER ABSTRACTION | IrrigationEfficiency | value/map | input | Field application irrigation efficiency max 1, ~0.90 drip irrigation, ~0.75 sprinkling | -| lfuser | WATER ABSTRACTION | ConveyanceEfficiency | value/map | input | onveyance efficiency, around 0.80 for average channel | -| lfuser | WATER ABSTRACTION | IrrigationType | value | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | -| lfuser | WATER ABSTRACTION | IrrigationMult | value | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | -| lfuser | WATER ABSTRACTION | LivestockConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | -| lfuser | WATER ABSTRACTION | IndustryConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | -| lfuser | WATER ABSTRACTION | EnergyConsumptiveUseFraction | value/map | input | Consumptive Use (1-Recycling ratio) for energy water use (0-1) Source: Torcellini et al. (2003) "Consumptive Use for US Power Production" map advised by Neil Edwards, Energy Industry the UK and small French rivers the consumptive use varies between 1:2 and 1:3, so 0.33-0.50 For plants along big rivers like Rhine and Danube the 0.025 is ok EnergyConsumptiveUseFraction=0.025 | -| lfuser | WATER ABSTRACTION | DomesticConsumptiveUseFraction | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | -| lfuser | WATER ABSTRACTION | LeakageFraction | value | input | $(PathMaps)/leakage.map Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | -| lfuser | WATER ABSTRACTION | LeakageWaterLoss | value | input | The water that is lost from leakage (lost) (0-1) | -| lfuser | WATER ABSTRACTION | LeakageReductionFraction | value | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | -| lfuser | WATER ABSTRACTION | WaterSavingFraction | value | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | -| lfuser | CALC INDICATOR | Population | map | input | Population per pixel | -| lfuser | CALC INDICATOR | PopulationMaps | map | input | Population map for TransientLandUseChange | -| lfuser | CALC INDICATOR | LandUseMask | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | -| lfuser | WATER ABSTRACTION | WaterUseMaps | map | output | path and prefix of the reported water use m3 s-1 as a result of demand and availability | -| lfuser | WATER ABSTRACTION | WaterUseTS | tss | output | Time series of upstream water use at gauging stations | -| lfuser | WATER ABSTRACTION | StepsWaterUseTS | tss | output | number of loops needed for water use routine | -| lfuser | WATER ABSTRACTION | maxNoWateruse | value | input | maximum number of loops for calculating the use of water | -| lfuser | WATER ABSTRACTION | WUsePercRemain | value | input | percentage of water that must remain the channel (after water abstraction) | -| lfuser | WATER ABSTRACTION / CALC INDICATOR | WUseRegion | map | input | area from which surface water is extracted | -| lfuser | GROUNDWATER | LZSmoothRange | value | input | length of the window used to smooth the LZ zone [number of cell length] It works ONLY if wateruse=1 | -| lfuser | GROUNDWATER | GroundwaterBodies | map | input | map of aquifers (0/1), used to smoothen LZ near extraction areas | -| lfuser | LAKES | LakeMask | map | input | Mask with Lakes from GLWD database | -| lfuser | TRANSMISSION | TransPower1 | value | input par | Transmission loss function parameter. Default = 2.0 | -| lfuser | TRANSMISSION | TransArea | value | input par | downstream area taking into account for transmission loss | -| lfuser | TRANSMISSION / RESERVOIR | UpAreaTrans | map | inpput | upstream area for transmission loss and computation of K coeff in reservoirs module | -| lfuser | KINEMATIC WAVE | beta | value | input par | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | -| lfuser | KINEMATIC WAVE | OFDepRef | value | input par | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | -| lfuser | KINEMATIC WAVE | GradMin | value | input par | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | -| lfuser | KINEMATIC WAVE | ChanGradMin | value | input par | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | -| lfuser | MCT DIFFUSIVE WAVE | ChannelsMCT | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | -| lfuser | MCT DIFFUSIVE WAVE | ChanGradMaxMCT | value | input par | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) [m m-1] | -| lfuser | DOUBLE KINEMATIC WAVE | QSplitMult | value | input par | PBchange Multiplier applied to average Q to split into a second line of routing | -| lfuser | SOIL | CourantCrit | value | input par | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | -| lfuser | RESERVOIRS | DtSecReservoirs | value | input | Sub time step used for reservoir simulation [s]. Within the model, the smallest out of DtSecReservoirs and DtSec is used. | -| lfuser | RESERVOIRS | ReservoirInitialFillValue | value/map | input initial/internal | Initial reservoir fill fraction -9999 sets initial fill to normal storage limit if you're not using the reservoir option, enter some bogus value | -| lfuser | LAKES | TabLakeAvNetInflowEstimate | table | input | Estimate of average net inflow into lake (=inflow - evaporation) [cu m / s] Used to calculated steady-state lake level in case LakeInitialLevelValue is set to -9999 | -| lfuser | INFLOW | InflowPoints | map | input forcings | OPTIONAL: nominal map with locations of (measured) inflow hydrographs [cu m / s] | -| lfuser | INFLOW | QInTS | tss | input forcings | OPTIONAL: observed or simulated input hydrographs as time series [cu m / s] Note that identifiers in time series correspond to InflowPoints map (also optional) | -| lfuser | SOIL | HeadMax | value | input | Maximum capillary head [cm]. This value is used if Theta equals residual soil moisture content (value of HeadMax is arbitrary). Only needed for pF computation, otherwise doesn't influence model results at all) | -| lfuser | EVAPORATION FROM OPEN WATER | maxNoEva | 10 | value | input | - - -## **Table:** *lfbinging section in OS LISFLOOD settings xml* - -| section (XML) | module | KEY | settings | Type | I/O | Description | -|:------------------------|:---------------------------------------------------------------|:-------------------------------------------|:------------------------------------------------------|:------------------------|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfbinding | SNOW AND FROST | Afrost | $(Afrost) | value | input | Daily decay coefficient. It is the frost index decay coefficient [day-1]. It has a value in the range 0-1. | -| lfbinding | INITIAL CONDITION | AvgDis | $(PathInit)/avgdis.map | map | input initial/internal | $(PathInit)/avgdis.map CHANNEL split routing in two lines Average discharge map [m3/s] | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | AvWaterRateThreshold | $(AvWaterRateThreshold) | value | input | It defines a critical amount of water that is used as a threshold for resetting the variable Dslr. The threshold is defined as an equivalent intensity in [mm day-1] Critical amount of available water (expressed in [mm/day]!), above which 'Days Since Last Rain' parameter is set to 1 default: 5.0 (not included in calibration) | -| lfbinding | INFILTRATION | b_Xinanjiang | $(b_Xinanjiang) | map | input | Power in Xinanjiang distribution function. [-] It is the power in the infiltration equation. Default: 0.7 | -| lfbinding | ROUTING | beta | $(beta) | 0 | input | It is the routing coefficient in Manning's equation (2/3). kinematic wave parameter: 0.6 is for broad sheet flow | -| lfbinding | ROUTING | CalChanMan | $(CalChanMan) | 0 | input | It is a multiplier that is applied to the Manning's roughness map of the channel system default: 2.0 $(PathParams)/params_CalChanMan1.nc | -| lfbinding | ROUTING | CalChanMan2 | $(CalChanMan2) | value/map | input | Multiplier applied to Channel Manning's n for second routing line default: 3.0 $(PathParams)/params_CalChanMan2.nc | -| lfbinding | ROUTING | CalChanMan3 | $(CalChanMan3) | value/map | input | Multiplier [-] applied to Channel Manning's n for MCT routing default: 3.0 $(PathParams)/params_CalChanMan3.nc | -| lfbinding | TIMESTEP RELATED PARAMETERS | CalendarDayStart | $(CalendarDayStart) | date | input | Reference Calendar day of the model. It is used inside LISFLOOD code as the reference date for time step id numbers. It MUST be <= first simulation start date. | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | CalEvaporation | $(CalEvaporation) | value | input | Multiplier applied to potential evapo(transpi)ration rates. Default = 1.0, not used in calibration. | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChanCrossSectionEnd | $(PathOut)/chcro.end | map | output/end | Reported chan cross-section area [m2] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanCrossSectionState | $(PathOut)/chcro | map | output/state | Reported chan cross-section area [m2] | -| lbinding | ROUTING | ChanGradMaxMCT | $(ChanGradMaxMCT) | map | input | Maximum channel gradient for channels using MCT routing [-] (for MCT wave: slope cannot be 0) | -| lfbinding | ROUTING | ChanGradMin | $(ChanGradMin) | nan | input | Minimum channel gradient (for kin. wave: slope cannot be 0) It is a lower limit for the channel gradient used in the calculation of the channel flow velocity [m m-1] | -| lbinding | ROUTING | ChannelsMCT | $(ChannelsMCT) | map | input | Boolean map with value 1 at channel pixels where MCT is used, and 0 at all other pixels | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQAvgDtEnd | $(PathOut)/chanqavgdt.end | map | output/end | Reported average discharge on the last routing sub-step [cu m/s] ChanQAvgDt | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQAvgDtState | $(PathOut)/chanqavgdt | map | output/state | Reported average discharge the last routing sub-step [cu m/s] ChanQAvgDt | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChanQEnd | $(PathOut)/chanq.end | map | output/end | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChanQState | $(PathOut)/chanq | map | output/state | Reported istantaneous discharge at end of computation step [cu m/s] ChanQ | -| lfbinding | REPORTED OUTPUT MAPS (END) | ChSideEnd | $(PathOut)/chside.end | map | output/end | Reported channel side flow | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | ChSideState | $(PathOut)/chside | map | output/state | Reported sideflow to channel for first line of routing [m3/s] | -| lfbinding | WATER USE MAPS AND PAR | ConveyanceEfficiency | $(ConveyanceEfficiency) | map | input | onveyance efficiency, around 0.80 for average channel | -| lfbinding | NUMERICS | CourantCrit | $(CourantCrit) | value | input | Minimum value for Courant condition in soil moisture routine. Always less than or equal to 1. Small values result in improved numerical accuracy, at the expense of increased computing time (more sub-steps needed). If reported time series of soil moisture contain large jumps, lowering CourantCrit should fix this | -| lfbinding | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | input initial/internal | initial channel crosssection for 2nd routing channel -9999: use 0 | -| lfbinding | REPORTED OUTPUT MAPS (END) | CrossSection2End | $(PathOut)/ch2cr.end | map | output/end | Cross section area for split routing [m2] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CrossSection2State | $(PathOut)/ch2cr | map | output/state | Cross section area for split routing [m2] | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionEnd | $(PathOut)/cum.end | map | output/end | Reported interception storage | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionForestEnd | $(PathOut)/cumf.end | map | output/end | Reported interception storage for forest | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionForestState | $(PathOut)/cumf | map | output/state | Reported interception storage for forest | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumInterceptionIrrigationEnd | $(PathOut)/cumi.end | map | output/end | Reported interception storage for irrigation | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionIrrigationState | $(PathOut)/cumi | map | output/state | Reported interception storage | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumInterceptionState | $(PathOut)/cum | map | output/state | Reported interception storage | -| lfbinding | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | input initial/internal | cumulative interception forest [mm] | -| lfbinding | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | input initial/internal | cumulative interception [mm] | -| lfbinding | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | input initial/internal | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | CumIntSealedEnd | $(PathOut)/cseal.end | map | output/end | Reported depression storage | -| lfbinding | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | input initial/internal | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | CumIntSealedState | $(PathOut)/cseal | map | output/state | Reported depression storage | -| lfbinding | REPORTED OUTPUT MAPS (END) | DischargeEnd | $(PathOut)/dis.end | map | output/end | Reported average discharge on the model timestep [m3/s] | -| lfbinding | REPORTED OUTPUT MAPS | DischargeMaps | $(PathOut)/dis | map | output | Reported average discharge [cu m/s] (average over model timestep) | -| lfbinding | REPORTED OUTPUT MAPS | DisMaps | $(PathOut)/q | map (missing) | output | Reported discharge [cu m/s] at the end of a timestep | -| lfbinding | WATER USE MAPS AND PARAMETERS | DomesticConsumptiveUseFraction | $(DomesticConsumptiveUseFraction) | value | input | Consumptive Use (1-Recycling ratio) for domestic water use (0-1) Source: EEA (2005) State of Environment | -| lfbinding | INPUT WATER USE MAPS AND PAR | DomesticDemandMaps | $(PathWaterUse)/$(PrefixWaterUseDomestic) | map | input | Domestic water abstraction daily maps [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | DSLREnd | $(PathOut)/dslr.end | map | output/end | Reported days since last rain | -| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRForestEnd | $(PathOut)/dslf.end | map | output/end | Reported days since last rain for forest | -| lfbinding | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for forest [days] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRForestState | $(PathOut)/dslf | map | output/state | Reported days since last rain for forest | -| lfbinding | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | input initial/internal | days since last rainfall | -| lfbinding | REPORTED OUTPUT MAPS (END) | DSLRIrrigationEnd | $(PathOut)/dsli.end | map | output/end | Reported days since last rain for irrigation | -| lfbinding | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | input initial/internal | initial number of days since the last rainfall event for irrigation [days] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRIrrigationState | $(PathOut)/dsli | map | output/state | Reported days since last rain irrigation | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | DSLRMaps | $(PathOut)/dslr | map | output | Reported days since last rain | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | DSLRState | $(PathOut)/dslr | map | output/state | Reported days since last rain [ndays] | -| lfbinding | TIMESTEP RELATED PARAMETERS | DtSec | $(DtSec) | map | input | timestep [seconds]. This is the simulation time interval (86400-day; 3600-hour) | -| lfbinding | TIMESTEP RELATED PARAMETERS | DtSecChannel | $(DtSecChannel) | map | input | Sub time step used for kinematic wave channel routing [seconds] Within the model, the smallest out of DtSecChannel and DtSec is used Using a value that is smaller than DtSec may result in a better simulation of the overal shape of the calculated hydrograph | -| lfbinding | INPUT METEO AND VEG MAPS | E0Maps | $(PathMeteo)/$(PrefixE0) | map | input | daily reference evaporation (free water) [mm/day] | -| lfbinding | WATER USE MAPS AND PARAMETERS | EnergyConsumptiveUseFraction | $(EnergyConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for energy production water use (0-1) | -| lfbinding | INPUT WATER USE MAPS AND PAR | EnergyDemandMaps | $(PathWaterUse)/$(PrefixWaterUseEnergy) | map | input | Energy water abstraction daily maps [mm] | -| lfbinding | INPUT METEO AND VEG MAPS | ES0Maps | $(PathMeteo)/$(PrefixES0) | map | input | daily reference evaporation (soil) [mm/day] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ESRefMapsOut | $(PathOut)/es | map | output | Potential evaporation from bare soil surface [mm per time step] | -| lfbinding | INPUT METEO AND VEG MAPS | ET0Maps | $(PathMeteo)/$(PrefixET0) | map | input | daily reference evapotranspiration (crop) [mm/day] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | ETRefMapsOut | $(PathOut)/et | map | output | Potential reference evapotranspiration [mm per time step] | -| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenMaps | $(PathOut)/evaop | map (missing) | output | Reported evaporation from open water [mm] | -| lfbinding | EVAPORATION FROM OPEN WATER | EvaOpenTS | $(PathOut)/evaopenUps.tss | tss (missing) | output | Time series of upstream water evaporation from open water at gauging stations | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | EWRefMapsOut | $(PathOut)/ew | map | output | Potential evaporation from open water surface [mm per time step] | -| lfbinding | EVAPORATION FROM OPEN WATER | FracMaxWater | $(FracMaxWater) | value | input | Percentage of maximum extend of water | -| lfbinding | REPORTED OUTPUT MAPS (END) | FrostIndexEnd | $(PathOut)/frost.end | map | output/end | Reported frost index | -| lfbinding | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | input initial/internal | initial frost index value | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | FrostIndexState | $(PathOut)/frost | map | output/state | Reported frost index | -| lfbinding | SNOW AND FROST | FrostIndexThreshold | $(FrostIndexThreshold) | map | input | Degree Days Frost Threshold (stops infiltration, percolation and capillary rise) Molnau and Bissel found a value 56-85 for NW USA. It is the critical value of the frost index (Eq 2-5) above which the soil is considered frozen [°C day-1] | -| lfbinding | ROUTING | GradMin | $(GradMin) | 0 | input | Minimum slope gradient of the surface (for kin. wave: slope cannot be 0) It is a lower limit for the slope gradient used in the calculation of the surface runoff flow velocity [m m-1] | -| lfbinding | GROUNDWATER RELATED PAR | GwLoss | $(GwLoss) | map | input | Maximum loss rate out of Lower response box, expressed as a fraction of lower zone outflow. Fraction [-], range 0-1 A value of 0 (closed lower boundary) is recommended as a starting value Maximum rate of percolation from the lower groundwater zone (groundwater loss) zone [mm day-1]. default: 0.0 | -| lfbinding | GROUNDWATER RELATED PAR | GwPercValue | $(GwPercValue) | map | input | Maximum rate of percolation going from the upper to the lower groundwater zone [mm day-1] default: 0.5 $(PathParams)/params_GwPercValue.nc | -| lfbinding | INPUT WATER USE MAPS AND PAR | IndustrialDemandMaps | $(PathWaterUse)/$(PrefixWaterUseIndustry) | map | input | Industry water abstraction daily maps [mm] | -| lfbinding | WATER USE MAPS AND PARAMETERS | IndustryConsumptiveUseFraction | $(IndustryConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for industrial water use (0-1) | -| lfbinding | WATER USE MAPS AND PAR | IrrigationEfficiency | $(IrrigationEfficiency) | map | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | -| lfbinding | WATER USE MAPS AND PAR | IrrigationMult | $(IrrigationMult) | map | input | Factor to irrigation water demand More than the transpiration is added e.g to prevent salinisation | -| lfbinding | WATER USE MAPS AND PAR | IrrigationType | $(IrrigationType) | map | input | IrrigationType (value between 0 and 1) is used here to distinguish between additional adding water until fieldcapacity (value set to 1) or not (value set to 0) | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | kdf | $(kdf) | value | input | Average extinction coefficient for the diffuse radiation flux varies with crop from 0.4 to 1.1 (Goudriaan (1977)) It is used to calculate the extinction coefficient for global radiation kgb. Deafult = 0.72 | -| lfbinding | SNOW AND FROST | Kfrost | $(Kfrost) | map | input | Snow depth reduction coefficient, [cm-1] | -| lfbinding | INPUT METEO AND VEG MAPS | LAIForestMaps | $(PathLAI)/$(PrefixLAIForest) | map | input | leaf area index forest [m2/m2] | -| lfbinding | INPUT METEO AND VEG MAPS | LAIIrrigationMaps | $(PathLAI)/$(PrefixLAIIrrigation) | map | input | leaf area index irrigation [m2/m2] | -| lfbinding | INPUT METEO AND VEG MAPS | LAIOtherMaps | $(PathLAI)/$(PrefixLAIOther) | map | input | leaf area index [m2/m2] | -| lfbinding | REPORTED OUTPUT MAPS (END) | LakeLevelEnd | $(PathOut)/lakeh.end | map | output/end | Reported lake level | -| lfbinding | EVAPORATION FROM OPEN WATER | LakeMask | $(LakeMask) | map | input | Mask with Lakes from GLWD database | -| lfbinding | REPORTED OUTPUT MAPS (END) | LakeStorageM3 | $(PathOut)/lakest | map | output | Reported lake storage | -| lfbinding | WATER USE MAPS AND PAR | LandUseMask | $(LandUseMask) | map | input | Land use mask map to mask out deserts and high mountains (to cover ETdif map, otherwise Sahara etc would pop out; meant as a drought indicator | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | LeafDrainageTimeConstant | $(LeafDrainageTimeConstant) | map | input | Time constant for leaf drainage | -| lfbinding | WATER USE MAPS AND PARAMETERS | LeakageFraction | $(LeakageFraction) | map | input | Fraction of leakage of public water supply (0=no leakage, 1=100% leakage) | -| lfbinding | WATER USE MAPS AND PAR | LeakageReductionFraction | $(LeakageReductionFraction) | map | input | Leakage reduction fraction (e.g. 50% = 0.5 as compared to current Leakage) (baseline=0, maximum=1) | -| lfbinding | WATER USE MAPS AND PAR | LeakageWaterLoss | $(LeakageWaterLoss) | 0 | input | The water that is lost from leakage (lost) (0-1) | -| lfbinding | IRRIGATION AND WATER ABSTRACTION | LivestockConsumptiveUseFraction | $(LivestockConsumptiveUseFraction) | map | input | Consumptive Use (1-Recycling ratio) for livestock water use (0-1) | -| lfbinding | INPUT WATER USE MAPS AND PAR | LivestockDemandMaps | $(PathWaterUse)/$(PrefixWaterUseLivestock) | map | input | Livestock water abstraction daily maps [mm] | -| lfbinding | GROUNDWATER RELATED PAR | LowerZoneTimeConstant | $(LowerZoneTimeConstant) | map | input | Time constant for the lower groundwater zone [days] | -| lfbinding | INITIAL CONDITION | LZAvInflowMap | $(PathInit)/lzavin.map | value/map | input initial/internal | $(PathInit)/lzavin.map Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | -| lfbinding | REPORTED OUTPUT MAPS (END) | LZEnd | $(PathOut)/lz.end | map | output/end | Reported storage in lower groundwater zone response box [mm] | -| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | input initial/internal | water in lower store [mm] -9999: use steady-state storage | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | LZMaps | $(PathOut)/lz | map | output | Reported storage in lower groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | LZState | $(PathOut)/lz | map | output/state | Reported storage in lower response box [mm] | -| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropCoef | $(PathMapsTables)/cropcoef_i.map | table | input | Irrigation crop coefficient | -| lfbinding | WATER USE MAPS AND PAR | MapIrrigationCropGroupNumber | $(PathMapsTables)/cropgrpn_i.map | table | input | Irrigation crop group number | -| lfbinding | REPORTED OUTPUT MAPS | MaskDischargeMaps | $(PathOut)/dism | map (missing) | output | Reported discharge [cu m/s] but cut by a discharge mask map | -| lfbinding | SETTINGS | MaskMap | $(MaskMap) | map/value | input | Clone map used to set computation area for Lisflood model It can be 5 values separated by a blank space: col row cellsize xupleft yupleft (3600 1500 0.1 -180 90 -> World) or a map in pcraster format or netcdf If a map is used, information are read from the map. | -| lfbinding | EVAPORATION FROM OPEN WATER | maxNoEva | $(maxNoEva) | value | input | Maximum number of loops for calculating evaporation (distance water is taken to satisfy the need of evaporation from open water). Default = 10 | -| lfbinding | WATER USE MAPS AND PAR | maxNoWateruse | $(maxNoWateruse) | value | input | maximum number of loops for calculating the use of water (=distance to the water demand cell) | -| lfbinding | SETTINGS | netCDFtemplate | $(netCDFtemplate) | map | input | netcdf template used to copy metadata information for writing netcdf | -| lfbinding | ROUTING | OFDepRef | $(OFDepRef) | 0 | input | It is a reference flow depth from which the flow velocity of the surface runoff is calculated [mm] Reference depth of overland flow [mm], used to compute overland flow Alpha for kin. wave | -| lfbinding | REPORTED OUTPUT MAPS (END) | OFDirectEnd | $(PathOut)/ofdir.end | map | output/end | Reported water volume for direct fraction on catchment surface | -| lfbinding | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | input initial/internal | Reported water volume for direct fraction on catchment surface [m^3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFDirectState | $(PathOut)/ofdir | map | output/state | Reported water volume for direct fraction on catchment surface [m3] | -| lfbinding | REPORTED OUTPUT MAPS (END) | OFForestEnd | $(PathOut)/offor.end | map | output/end | | -| lfbinding | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | input initial/internal | Reported water volume for other fraction on catchment surface [m^3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFForestState | $(PathOut)/offor | map | output/state | Reported water volume for forest fraction on catchment surface [m3] | -| lfbinding | REPORTED OUTPUT MAPS (END) | OFOtherEnd | $(PathOut)/ofoth.end | map | output/end | | -| lfbinding | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | input initial/internal | Reported water volume for forest fraction on catchment surface [m^3] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | OFOtherState | $(PathOut)/ofoth | map | output/state | Reported water volume for other fraction on catchment surface [m3] | -| lfbinding | WATER USE MAPS AND PAR | Population | $(Population) | map | input | Population per pixel | -| lfbinding | WATER USE MAPS AND PAR | PopulationMaps | $(PopulationMaps) | map | input | Population map for TransientLandUseChange | -| lfbinding | INFILTRATION | PowerPrefFlow | $(PowerPrefFlow) | map | input | Power that controls increase of proportion of preferential flow with increased soil moisture storage. It s the power in the preferential flow equation [-] default: 3.5 $(PathParams)/params_PowerPrefFlow.nc | -| lfbinding | INPUT METEO AND VEG MAPS | PrecipitationMaps | $(PathMeteo)/$(PrefixPrecipitation) | map | input | precipitation [mm/day] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | PrecipitationMapsOut | $(PathOut)/pr | map | output | Precipitation [mm per time step] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTEnd | $(PathOut)/prevcm.end | map | output/end | Reported Courant number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | input initial/internal | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevCmMCTState | $(PathOut)/prevcm | map | output/state | Reported Courant number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | input initial/internal | initial discharge from previous run for MCT diffusive routing -9999: use 0 | -| lfbinding | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | input initial/internal | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTEnd | $(PathOut)/prevdm.end | map | output/end | Reported Raynolds number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | input initial/internal | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | PrevDmMCTState | $(PathOut)/prevdm | map | output/state | Reported Reynolds number at previous step for MCT routing | -| lfbinding | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | input initial/internal | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | PrScaling | $(PrScaling) | value | input | Multiplier applied to potential precipitation rates | -| lfbinding | ROUTING | QSplitMult | $(QSplitMult) | value | input | PBchange Multiplier applied to average Q to split into a second line of routing | -| lfbinding | REPORTED OUTPUT MAPS (END) | ReservoirFillEnd | $(PathOut)/rsfil.end | map | output/end | Reported reservoir filling | -| lfbinding | RICE IRRIGATION | RiceFlooding | 10 | 0 | input | water amount in mm per day 10 mm for 10 days (total 10cm water) | -| lfbinding | RICE IRRIGATION | RiceHarvestDay1 | $(PathMapsTables)/riceharvestday1.map | map | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RiceHarvestDay2 | $(PathMapsTables)/riceharvestday2.map | map | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RicePercolation | 2 | 0 | input | FAO: percolation for heavy clay soils: PERC = 2 mm/day | -| lfbinding | RICE IRRIGATION | RicePlantingDay1 | $(PathMapsTables)/riceplantingday1.map | table | input | map with starting day of the year | -| lfbinding | RICE IRRIGATION | RicePlantingDay2 | $(PathMapsTables)/riceplantingday2.map | table | input | map with starting day of the year | -| lfbinding | EVAPO(TRANSPI)RATION AND INTERCEPTION | SMaxSealed | $(SMaxSealed) | value | input | maximum depression storage for water on impervious surface which is not immediatly causing surface runoff [mm] This storage is emptied by evaporation (EW0) | -| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverAEnd | $(PathOut)/scova.end | map | output/end | Reported snow cover in snow zone A [mm] | -| lfbinding | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | input initial/internal | initial snow depth in snow zone A [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverAState | $(PathOut)/scova | map | output/state | Reported snow cover in snow zone A [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverBEnd | $(PathOut)/scovb.end | map | output/end | Reported snow cover in snow zone B [mm] | -| lfbinding | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | input initial/internal | initial snow depth in snow zone B [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverBState | $(PathOut)/scovb | map | output/state | Reported snow cover in snow zone B [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | SnowCoverCEnd | $(PathOut)/scovc.end | map | output/end | Reported snow cover in snow zone C [mm] | -| lfbinding | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | input initial/internal | initial snow depth in snow zone C [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | SnowCoverCState | $(PathOut)/scovc | map | output/state | Reported snow cover in snow zone C [mm] | -| lfbinding | SNOW AND FROST | SnowFactor | $(SnowFactor) | 0 | input | Multiplier applied to precipitation that falls as snow. Since snow is commonly underestimated in meteorological observation data, setting this multiplier to some value greater than 1 can counteract for this. Estimate from prior data if available, otherwise 1 | -| lfbinding | SNOW AND FROST | SnowMeltCoef | $(SnowMeltCoef) | 0 | input | Snowmelt coefficient [mm/deg C /day]. It is the degree-day factor that controls the rate of snowmelt default: 4.0 $(PathParams)/params_SnowMeltCoef.nc SRM: 0.45 cm/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) See also Martinec et al., 1998. | -| lfbinding | SNOW AND FROST | SnowSeasonAdj | $(SnowSeasonAdj) | 0 | input | It is the range [mm C-1 d-1] of the seasonal variation of snow melt. SnowMeltCoef is the average value. | -| lfbinding | SNOW AND FROST | SnowWaterEquivalent | $(SnowWaterEquivalent) | 0 | input | Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996) It is the equivalent water depth of a given snow cover, expressed as a fraction [-] | -| lfbinding | TIMESTEP RELATED PARAMETERS | StepEnd | $(StepEnd) | value/date | input | Step id number or date of end time step in simulation. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be <= Calendar DayStart and >= StepStart | -| lfbinding | TIMESTEP RELATED PARAMETERS | StepStart | $(StepStart) | value/date | input | Step id number or date of the simulation start step. See code for a list of available date formats. If number is used, it refers to "CalendarDayStart". For dates, also HH:MM can be set. If they are not set, 00:00 are automatically used. StepStart MUST be >= Calendar DayStart and <= StepEnd | -| lfbinding | WATER USE MAPS AND PAR | StepsWaterUseTS | $(StepsWaterUseTS) | tss | input | number of loops needed for water use routine | -| lfbinding | REPORTED OUTPUT MAPS | SurfaceSoilMoistureMaps | $(PathOut)/wta | map (missing) | output | Reported surface soil moisture [%] | -| lfbinding | INPUT METEO AND VEG MAPS | TavgMaps | $(PathMeteo)/$(PrefixTavg) | map | input | average daily temperature [C] | -| lfbinding | REPORTED OUTPUT MAPS (DRIVING METEO VAR) | TavgMapsOut | $(PathOut)/tav | map | output | Average DAILY temperature [degrees C] | -| lfbinding | SNOW AND FROST | TemperatureLapseRate | $(TemperatureLapseRate) | 0 | input | Temperature lapse rate with altitude [deg C / m] It is the temperature lapse rate that is used to estimate average temperature at the centroid of each pixel’s elevation zones [°C m-1] | -| lfbinding | SNOW AND FROST | TempMelt | $(TempMelt) | 0 | input | It is the degree-day factor that controls the rate of snowmelt [mm °C-1 day-1] | -| lfbinding | SNOW AND FROST | TempSnow | $(TempSnow) | 0 | input | It is the average temperature below which precipitation is assumed to be snow [°C] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1End | $(PathOut)/tha.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1ForestEnd | $(PathOut)/thfa.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a for forest [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1ForestState | $(PathOut)/thfa | map | output/state | theta for soil layer 1a forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta1IrrigationEnd | $(PathOut)/thia.end | map | output/end | Reported volumetric soil moisture content for soil layer 1a [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1IrrigationState | $(PathOut)/thia | map | output/state | Reported volumetric soil moisture content for soil layer 1a for irrigation[V/V] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta1Maps | $(PathOut)/thtop | map | output | Reported volumetric soil moisture content for soil layer 1 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta1State | $(PathOut)/tha | map | output/state | Reported volumetric soil moisture content for soil layer 1 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2End | $(PathOut)/thb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2ForestEnd | $(PathOut)/thfb.end | map | output/end | Reported volumetric soil moisture content for both soil layer 1b for forest [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2ForestState | $(PathOut)/thfb | map | output/state | theta for soil layer 1b forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta2IrrigationEnd | $(PathOut)/thib.end | map | output/end | Reported volumetric soil moisture content for soil layer 1b [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2IrrigationState | $(PathOut)/thib | map | output/state | Reported volumetric soil moisture content for both soil layer 1b for irrigation [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta2State | $(PathOut)/thb | map | output/state | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3End | $(PathOut)/thc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3ForestEnd | $(PathOut)/thfc.end | map | output/end | Reported volumetric soil moisture content for both soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3ForestState | $(PathOut)/thfc | map | output/state | theta for soil layer 2 forest fraction | -| lfbinding | REPORTED OUTPUT MAPS (END) | Theta3IrrigationEnd | $(PathOut)/thic.end | map | output/end | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3IrrigationState | $(PathOut)/thic | map | output/state | Reported volumetric soil moisture content for both soil layer 2 for irrigation [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | Theta3Maps | $(PathOut)/thbot | map | output | Reported volumetric soil moisture content for soil layer 2 [V/V] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | Theta3State | $(PathOut)/thc | map | output/state | Reported volumetric soil moisture content for both soil layer 3 [V/V] | -| lfbinding | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | input initial/internal | initial soil moisture content layer 1a for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | input initial/internal | initial soil moisture content layer 1b for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | input initial/internal | initial soil moisture content layer 2 for irrigation -9999: use field capacity values | -| lfbinding | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | input initial/internal | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfbinding | REPORTED OUTPUT MAPS | TopSoilMoistureMaps | $(PathOut)/wt | map (missing) | output | Reported Topsoil moisture [%] | -| lfbinding | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | input initial/internal | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotalRunoffMaps | $(PathOut)/trun | map | output | Reported total runoff [mm/∆t] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | TotaltoChanMaps | $(PathOut)/ttoc | map | output | Reported total runoff that enters the channel: groundwater + surface runoff [mm/∆t] | -| lfbinding | TRANSMISSION LOSS | TransArea | $(TransArea) | 0 | input | PBchange downstream area taking into account for transmission loss | -| lfbinding | TRANSMISSION LOSS | TransPower1 | $(TransPower1) | 0 | input | PBchange Transmission loss function parameter | -| lfbinding | TRANSMISSION LOSS | TransSub | $(TransSub) | 0 | input | PBchange Transmission loss function parameter | -| lfbinding | TRANSMISSION LOSS | UpAreaTrans | $(UpAreaTrans) | 0 | input | upstream area for transmission loss | -| lfbinding | GROUNDWATER RELATED PAR | UpperZoneTimeConstant | $(UpperZoneTimeConstant) | map | input | Time constant for the upper groundwater zone [days] default: 10 $(PathParams)/params_UpperZoneTimeConstant.nc Time constant for water in upper zone [days*mm^GwAlpha] Note that units are days if GwAlpha=0 (linear reservoir] | -| lfbinding | REPORTED OUTPUT MAPS (END) | UZEnd | $(PathOut)/uz.end | map | output/end | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | UZForestEnd | $(PathOut)/uzf.end | map | output/end | Reported storage in upper groundwaterzone response box [mm] | -| lfbinding | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | input initial/internal | Initial water storage water in upper groundwater zone for forest [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZForestState | $(PathOut)/uzf | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | input initial/internal | water in upper groundwater zone [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | UZIrrigationEnd | $(PathOut)/uzi.end | map | output/end | Reported storage in upper groundwater zone response box for irrigation [mm] | -| lfbinding | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | input initial/internal | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZIrrigationState | $(PathOut)/uzi | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | UZMaps | $(PathOut)/uz | map | output | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL RATE VAR AT EVERY TIME STEP) | UZOutflowMaps | $(PathOut)/quz | map | output | Reported upper groundwater zone outflow [mm/∆t] | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | UZState | $(PathOut)/uz | map | output/state | Reported storage in upper groundwater zone response box [mm] | -| lfbinding | REPORTED OUTPUT MAPS (END) | WaterDepthEnd | $(PathOut)/wdept.end | map | output/end | Reported overlandflow water depth | -| lfbinding | OUPUT | WaterDepthInitValue | $(WaterDepthInitValue) | map | input | initial overland flow water depth [mm] | -| lfbinding | REPORTED OUTPUT MAPS (INDIVIDUAL STATE VAR AT EVERY TIME STEP) | WaterDepthMaps | $(PathOut)/wdept | map | output | Reported water depth | -| lfbinding | REPORTED OUTPUT MAPS (STATE VARIABLES AT SELECTED TIME STEPS) | WaterDepthState | $(PathOut)/wdept | map | output | Reported overland flow water depth | -| lfbinding | REPORTED OUTPUT MAPS | WaterLevelMaps | $(PathOut)/wl | map | output | Reported water level [m] | -| lfbinding | WATER USE MAPS AND PAR | WaterReUseFraction | $(WaterReUseFraction) | 0 | input | Fraction of water re-used in industry (e.g. 50% = 0.5 = half of the water is re-used, used twice (baseline=0, maximum=1 scenruse.map | -| lfbinding | WATER USE MAPS AND PAR | WaterSavingFraction | $(WaterSavingFraction) | 0 | input | Water savings fraction (e.g. 10% = 0.1 as compared to current Use (baseline=0, maximum=1) scenwsav.map | -| lfbinding | WATER USE MAPS AND PAR | WaterUseMaps | $(WaterUseMaps) | map | input | Reported water use m3 s-1 depending on the availability of discharge | -| lfbinding | WATER USE MAPS AND PAR | WaterUseTS | $(WaterUseTS) | tss | input | Time series of upstream water use at gauging stations | -| lfbinding | EVAPORATION FROM OPEN WATER | WFracOfDay | $(PathTables)/WFracOfDay.txt | map | input | table with days for each water use maps 1st column: range of days; 2nd column: suffix of wuse map | -| lfbinding | EVAPORATION FROM OPEN WATER | WFractionMaps | $(PathVarWaterfraction)/$(PrefixVarWaterFraction) | map | input | water use daily maps with a (in this case negative) volume of water [cu m/s] | -| lfbinding | WATER USE MAPS AND PAR | WUsePercRemain | $(WUsePercRemain) | value | input | percentage of water that must remain in a grid cell and is not withdrawn by water use e.g. 0.2 = 20 percent of discharge is not taken out | -| lfbinding | WATER USE MAPS AND PAR | WUseRegion | $(WUseRegion) | map | input | water use region | -| lfbinding | ROUTING | ChanBottomWMult, ChanDepthTMult, ChanSMult | $(ChanBottomWMult) $(ChanDepthMult) $(ChanSMult) | value/map | input | Multipliers used to adjust channel geometry. Default = 1.0 (not included in calibration) . | -| lfbinding | INITIAL CONDITION | CumQEnd | $(CumQEnd) | map | output | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | CumQInit | $(CumQInit) | map | input initial/internal | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestEnd | $(cumSeepTopToSubBForestEnd) | map | output | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationEnd | $(cumSeepTopToSubBIrrigationEnd) | map | output | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherEnd | $(cumSeepTopToSubBOtherEnd) | map | output | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | input initial/internal | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfbinding | INITIAL CONDITION | LZInflowCumEnd | $(LZInflowCumEnd) | map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | value/map | input initial/internal | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfbinding | SETTINGS | MapsCaching | $(MapsCaching) | value | input | Optimization of netCDF I/O through chunking and caching: True/False define whether input maps are cached/NOT cached | -| lfbinding | SETTINGS | NetCDFTimeChunks | $(NetCDFTimeChunks) | value | input | Optimization of netCDF I/O through chunking and caching: how to load the stacks of NetCDF files (e.g. -1 load everything upfront; "auto" let xarray decide) | -| lfbinding | SETTINGS | NumDaysSpinUp | $(NumDaysSpinUp) | value | input | Number of days to be discarded when computing the average fluxes in the initialization (prerun) simulation. Recommended: 1095 | -| lfbinding | SETTINGS | OutputMapsChunks | $(OutputMapsChunks) | value | input | Optimization of netCDF I/O through chunking and caching: Dump outputs to disk every X steps (default 1) | -| lfbinding | SETTINGS | OutputMapsDataType | $(OutputMapsDataType) | value | input | Optimization of netCDF I/O through chunking and caching: Output data type, may take the following values: "float64" (required for end files and warm start), "float32" | -| lfbinding | DOUBLE KINEMATIC WAVE | QSplitMult | $(QSplitMult) | value/map | input calib par | Multiplier applied to average Q to split into a second line of routing | -| lfbinding | RESERVOIRS | ReservoirFloodOutflowFactor | $(ReservoirFloodOutflowFactor) | value/map | input calib par | default: 0.3. Factor of the 100-year return inflow (`ReservoirFloodOutflow`) that defines the inflow value that switches the reservoir routine to flood control mode, when exceeded. | -| lfbinding | RESERVOIRS | ReservoirFloodStorage | $(ReservoirFloodStorage) | value/map | input calib par | default: 0.75. Fraction of the total reservoir storage above which the reservoirs enters the flood control zone. | -| lfbinding | SOIL INIT | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | -| lfbinding | SOIL INIT | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | -| lfbinding | SOIL INIT | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | input initial/internal | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkEnd | $(TimeSinceStartPrerunChunkEnd) | map | output | Cumulative discharge. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | input initial/internal | Cumulative discharge. Required for the warm start of the pre-run. | - - - -## **Table:** *Variables required for model initialization.* - -| section (XML) | module | KEY | In settings xml | Type | Cold Start: prerun and run | Warm Start: preun | Warm Start: run | Description | -|:------------------------|:-------------------------------------------|:----------------------------------------|:----------------------------------------------|:-----------------------------|:---------------------------------------------------------------|:---------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| lfuser | INITIAL CONDITION | CrossSection2AreaInitValue | $(CrossSection2AreaInitValue) | value/map | -9999 | ch2cro.end.nc | ch2cro.end.nc | initial channel crosssection for 2nd routing channel -9999: use 0 | -| lfuser | INITIAL CONDITION | CumIntForestInitValue | $(CumIntForestInitValue) | value/map | 0 | cumf.end.nc | cumf.end.nc | cumulative interception forest [mm] | -| lfuser | INITIAL CONDITION | CumIntInitValue | $(CumIntInitValue) | value/map | 0 | cum.end.nc | cum.end.nc | cumulative interception [mm] | -| lfuser | INITIAL CONDITION | CumIntIrrigationInitValue | $(CumIntIrrigationInitValue) | value/map | 0 | cumi.end.nc | cumi.end.nc | cumulative interception irrigation [mm] It is the initial value of the interception storage for the irrigation part of a pixel [mm] | -| lfuser | INITIAL CONDITION | CumIntSealedInitValue | $(CumIntSealedInitValue) | value/map | 0 | cseal.end.nc | cseal.end.nc | cumulative depression storage [mm] depression storage for surface runoff from imperious surface | -| lfuser | INITIAL CONDITION | DSLRForestInitValue | $(DSLRForestInitValue) | value/map | 1 | dslf.end.nc | dslf.end.nc | initial number of days since the last rainfall event for forest [days] | -| lfuser | INITIAL CONDITION | DSLRInitValue | $(DSLRInitValue) | value/map | 1 | dslr.end.nc | dslr.end.nc | days since last rainfall | -| lfuser | INITIAL CONDITION | DSLRIrrigationInitValue | $(DSLRIrrigationInitValue) | value/map | 1 | dsli.end.nc | dsli.end.nc | initial number of days since the last rainfall event for irrigation [days] | -| lfuser | INITIAL CONDITION | FrostIndexInitValue | $(FrostIndexInitValue) | value/map | 0 | frost.end.nc | frost.end.nc | initial frost index value | -| lfuser | INITIAL CONDITION | LZAvInflowMap | $(PathMaps)/lzavin.map | value/map | run: lzavin.nc; prerun: not needed | Not needed | Not needed | Reported map of average percolation rate from upper to lower groundwater zone (reported for end of simulation) | -| lfuser | INITIAL CONDITION | OFDirectInitValue | $(OFDirectInitValue) | value/map | 0 | ofdir.end.nc | ofdir.end.nc | Reported water volume for direct fraction on catchment surface [m^3] | -| lfuser | INITIAL CONDITION | OFForestInitValue | $(OFForestInitValue) | value/map | 0 | offor.end.nc | offor.end.nc | Reported water volume for other fraction on catchment surface [m^3] | -| lfuser | INITIAL CONDITION | OFOtherInitValue | $(OFOtherInitValue) | value/map | 0 | ofoth.end.nc | ofoth.end.nc | Reported water volume for forest fraction on catchment surface [m^3] | -| lfuser | INITIAL CONDITION | PrevCmMCTInitValue | $(PrevCmMCTInitValue) | value/map | -9999 | prevcm.end.nc | prevcm.end.nc | Courant number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 0 | -| lfuser | INITIAL CONDITION | PrevDischarge | $(PrevDischarge) | value/map | -9999 | chanq.end.nc | chanq.end.nc | initial discharge from previous run for MCT diffusive routing -9999: use 0 | -| lfuser | INITIAL CONDITION | PrevDischargeAvg | $(PrevDischargeAvg) | value/map | -9999 | chanqavgdt.end.nc | chanqavgdt.end.nc | initial discharge from previous run for lakes, reservoirs and transmission loss only needed for lakes reservoirs and transmission loss -9999: use 0 | -| lfuser | INITIAL CONDITION | PrevDmMCTInitValue | $(PrevDmMCTInitValue) | value/map | -9999 | prevdm.end.nc | prevdm.end.nc | Reynolds number at previous step for MCT diffusive routing [-]. A value of -9999 sets the initial value to 1 | -| lfuser | INITIAL CONDITION | PrevSideflowInitValue | $(PrevSideflowInitValue) | value/map | -9999 | chside.end.nc | chside.end.nc | initial inflow from each pixel to the channel [mm]. A value of -9999 sets the initial amount of sideflow to thye channel to 0 | -| lfuser | INITIAL CONDITION | SnowCoverAInitValue | $(SnowCoverAInitValue) | value/map | 0 | scova.end.nc | scova.end.nc | initial snow depth in snow zone A [mm] | -| lfuser | INITIAL CONDITION | SnowCoverBInitValue | $(SnowCoverBInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone B [mm] | -| lfuser | INITIAL CONDITION | SnowCoverCInitValue | $(SnowCoverCInitValue) | value/map | 0 | scovb.end.nc | scovb.end.nc | initial snow depth in snow zone C [mm] | -| lfuser | INITIAL CONDITION | ThetaForestInit1Value | $(ThetaForestInit1Value) | value/map | thf1.end.nd, prerun outpit (preferred0); -9999 | thf1.end.nc | thf1.end.nc | initial soil moisture content layer 1, forest -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaForestInit2Value | $(ThetaForestInit2Value) | value/map | thf2.end.nd, prerun outpit (preferred0); -9999 | thf2.end.nc | thf2.end.nc | initial soil moisture content layer 2, forest -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaForestInit3Value | $(ThetaForestInit3Value) | value/map | thf3.end.nd, prerun outpit (preferred0); -9999 | thf3.end.nc | thf3.end.nc | initial soil moisture content layer 3, forest -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaInit1Value | $(ThetaInit1Value) | value/map | th1.end.nd, prerun outpit (preferred0); -9999 | th1.end.nc | th1.end.nc | initial soil moisture content layer 1, other fraction -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaInit2Value | $(ThetaInit2Value) | value/map | th2.end.nd, prerun outpit (preferred0); -9999 | th2.end.nc | th2.end.nc | initial soil moisture content layer 2, other fraction -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaInit3Value | $(ThetaInit3Value) | value/map | th3.end.nd, prerun outpit (preferred0); -9999 | th3.end.nc | th3.end.nc | initial soil moisture content layer 3, other fraction -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaIrrigationInit1Value | $(ThetaIrrigationInit1Value) | value/map | thi1.end.nd, prerun outpit (preferred0); -9999 | thi1.end.nc | thi1.end.nc | initial soil moisture content layer 1, irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaIrrigationInit2Value | $(ThetaIrrigationInit2Value) | value/map | thi2.end.nd, prerun outpit (preferred0); -9999 | thi2.end.nc | thi2.end.nc | initial soil moisture content layer 2, irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION | ThetaIrrigationInit3Value | $(ThetaIrrigationInit3Value) | value/map | thi3.end.nd, prerun outpit (preferred0); -9999 | thi3.end.nc | thi3.end.nc | initial soil moisture content layer 3, irrigation -9999: use field capacity values | -| lfuser | INITIAL CONDITION | timestepInit | $(timestepInit) | value/date | Not Needed | value/date | value/date | If initial conditions are stored as netCDF stack, this variable sets which time step to use as initial step. It can be either a date (e.g. 1/1/2010) or a number (e.g. 5). If a number is used, it refers to "CalendarDayStart". (it is generally one step back compared to StepStart) If missing, netcdf file are read with no reference to 'time', either if they are a stack or not. timestepInit is ignored if netCDF file is a single netCDF file.. | -| lfuser | INITIAL CONDITION | TotalCrossSectionAreaInitValue | $(TotalCrossSectionAreaInitValue) | value/map | -9999 | chcro.end.nc | chcro.end.nc | initial cross-sectional area of flow in channel[m2] -9999: use half bankfull | -| lfuser | INITIAL CONDITION | UZForestInitValue | $(UZForestInitValue) | map | 0 | uzf.end.nc | uzf.end.nc | Initial water storage water in upper groundwater zone for forest [mm] | -| lfuser | INITIAL CONDITION | UZInitValue | $(UZInitValue) | value/map | 0 | uz.end.nc | uz.end.nc | water in upper groundwater zone [mm] | -| lfuser | INITIAL CONDITION | UZIrrigationInitValue | $(UZIrrigationInitValue) | value/map | 0 | uzi.end.nc | uzi.end.nc | Initial water storage water in upper groundwater zone for irrigation [mm] | -| lfuser | INITIAL CONDITION | cumSeepTopToSubBForestInit | $(cumSeepTopToSubBForestInit) | value/map | 0 | cumSeepTopToSubBForest.end.nc | Not needed | Cumulative flux from second to third soil layer, forest land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | INITIAL CONDITION | cumSeepTopToSubBIrrigationInit | $(cumSeepTopToSubBIrrigationInit) | value/map | 0 | cumSeepTopToSubBIrrigated.end.nc | Not needed | Cumulative flux from second to third soil layer, irrigated land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | INITIAL CONDITION | cumSeepTopToSubBOtherInit | $(cumSeepTopToSubBOtherInit) | value/map | 0 | cumSeepTopToSubBOther.end.nc | Not needed | Cumulative flux from second to third soil layer, other land cover fraction. Prerun output, used to initilize soil water content in the cold start. | -| lfuser | INITIAL CONDITION | LZInflowCumInit | $(LZInflowCumInit) | map | 0 | LZInflowCum.end.nc | Not needed | Cumulative number of days from the start of the prerun. Required for the warm start of the pre-run. | -| lfuser | INITIAL CONDITION | TimeSinceStartPrerunChunkInit | $(TimeSinceStartPrerunChunkInit) | map | 0 | TimeSinceStartPrerunChunk.end.nc | Not needed | Cumulative discharge. Required for the warm start of the pre-run. | -| lfuser | INITIAL CONDITION | CumQInit | $(CumQInit) | map | 0 | CumQEnd.nc | Not needed | Cumulative inflow to the lower groundwater zone. Required for the warm start of the pre-run. | -| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageForestMap | $(PathInit)/SeepTopToSubBAverageForestMap | map | run: SeepTopToSubBAverageForestMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, forest land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageIrrigationMap | $(PathInit)/SeepTopToSubBAverageIrrigationMap | map | run: SeepTopToSubBAverageIrrigationMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, irrigation land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | SeepTopToSubBAverageOtherMap | $(PathInit)/SeepTopToSubBAverageOtherMap | map | run: SeepTopToSubBAverageOtherMap.nc; prerun: not needed | Not needed | Not needed | Reported infiltration from the soil layer 2 to soil layer 3, other land cover fraction, average flux over the simulation period | -| lfbinding | INITIAL CONDITION | AvgDis | $(PathMaps)/avgdis.map | map | run: avgdis.nc; prerun: not needed | Not needed | Not needed | Reported map of average discharge (reported for end of simulation) | -| lfbinding | INITIAL CONDITION | LZInitValue | $(LZInitValue) | value/map | -9999 | lz.end.nc | lz.end.nc | water in lower store [mm] -9999: use steady-state storage | From 5219a8f73b62e4f5e4b643966e5b4a770aea420f Mon Sep 17 00:00:00 2001 From: doc78 Date: Thu, 18 Jun 2026 15:41:19 +0000 Subject: [PATCH 70/70] Fixed relative paths in docs --- README.md | 2 +- docs/1_introduction_LISFLOOD/index.md | 2 +- .../index.md | 10 +++++----- docs/3_step2_preparing-setting-file/index.md | 14 +++++++------- docs/3_step3_preparing-input-files/index.md | 4 ++-- docs/3_step4_model-initialisation/index.md | 11 ++++++----- docs/3_step5_model-cold-warm-start-runs/index.md | 2 +- docs/3_step6_model-output/index.md | 6 +++--- docs/4_Static-Maps-introduction/index.md | 2 +- docs/4_Static-Maps_reservoirs-lakes/index.md | 8 ++++---- docs/4_Static-Maps_water-use/index.md | 2 +- docs/5_annex_output-files/index.md | 2 +- docs/5_annex_settings_and_options/index.md | 8 ++++---- docs/_config.yml | 4 ++-- 14 files changed, 39 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 8f8e62e1..e019e6c3 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,7 @@ pytest tests/ -m "slow" These tests could take 30 minutes or several hours, depending on your machine. -You can find full description and implementation details at [Test documentation](https://ec-jrc.github.io/lisflood-code/4_annex_tests/) page. +You can find full description and implementation details at [Test documentation](/docs/5_annex_tests/index.md) page. **Note**: If yuor pull request is about a new feature you may want to integrate in LISFLOOD, ensure to include tests with good coverage for it. diff --git a/docs/1_introduction_LISFLOOD/index.md b/docs/1_introduction_LISFLOOD/index.md index d4baaa9c..d100b24f 100644 --- a/docs/1_introduction_LISFLOOD/index.md +++ b/docs/1_introduction_LISFLOOD/index.md @@ -15,6 +15,6 @@ OS LISFLOOD can be used to generate long-term water balance simulations (climato Although LISFLOOD's primary output product is channel discharge, all internal rate and state variables (soil moisture, for example) can be written as output as well. All output can be written as grids, or time series at user-defined points or areas. The user has complete control over how output is written, thus minimising any waste of disk space or CPU time. -LISFLOOD is implemented in Python high level language: the users are recommented to refer to the chapter [Installation of the LISFLOOD model](3_step2_installation/index.md) and to the readme of the [OS LISFLOOD GitHub repository](https://github.com/ec-jrc/lisflood-code#lisflood-os) to find detailed information on requirements and installation protocol. +LISFLOOD is implemented in Python high level language: the users are recommented to refer to the chapter [Installation of the LISFLOOD model](../2_installation/index.md) and to the readme of the [OS LISFLOOD GitHub repository](https://github.com/ec-jrc/lisflood-code#lisflood-os) to find detailed information on requirements and installation protocol. [🔝](#top) diff --git a/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md index 255e478b..8fc6733d 100644 --- a/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md +++ b/docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md @@ -15,15 +15,15 @@ In order the run a simulation you will need: - An empty output directory where all model data can be written - OS LISFLOOD settings file in .xml format -The section [Input files](../3_step4_preparing-input-files) provides a detailed description of input maps and tables. +The section [Input files](../3_step3_preparing-input-files/index.md) provides a detailed description of input maps and tables. -The settings file (settings.xml) allows the selection of input maps, modelling options, and output variables and storage folder. The settings .xml is the essential argument of OS LISFLOOD command line. The section below presents its main components, an in depth descrition is provided in the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/). +The settings file (settings.xml) allows the selection of input maps, modelling options, and output variables and storage folder. The settings .xml is the essential argument of OS LISFLOOD command line. The section below presents its main components, an in depth descrition is provided in the section [Step 2: Preparing the Settings file](../3_step2_preparing-setting-file/index.md). ## OS LISFLOOD settings file (settings.xml) -All input files, output files, and parameter specifications are defined in a settings file. This file links variables and parameters in the model to in- and output files (maps, time series, tables) and numerical values. Moreover, the settings file can be used to specify the various model *options*. The settings file has a special (XML) structure. This page explains the general layout of the settings file; the section [Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of all the components of the file. +All input files, output files, and parameter specifications are defined in a settings file. This file links variables and parameters in the model to in- and output files (maps, time series, tables) and numerical values. Moreover, the settings file can be used to specify the various model *options*. The settings file has a special (XML) structure. This page explains the general layout of the settings file; the section [Step 2: Preparing the Settings file](../3_step2_preparing-setting-file/index.md) provides an in-depth description of all the components of the file. A LISFLOOD settings file is made up of 3 elements, each of which has a specific function. @@ -55,7 +55,7 @@ The sections ‘lfuser’, ‘lfoptions’ and ‘lfbinding’' have different p If Users leave the ‘lfoptions’ element empty, LISFLOOD will simply run using default options (i.e. run model without optional modules; only report most basic output files). However, the ‘lfoptions’ element itself (i.e. ) has to be present, even if empty. - A comprehensive list of available options and default values is contained in the [Annex: settings and options](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/). + A comprehensive list of available options and default values is contained in the [Annex: settings and options](../5_annex_settings_and_options/index.md). + **lfuser** contains user-defined definition of **paths** to all in- and output files, and main model parameters (calibration + time-related). @@ -114,7 +114,7 @@ In Settings file, three different keys are used to specify start date, end date ### Using timestamps -Timestamps (dates) can be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart ([Step 2: Preparing the Settings file](..//3_step3_preparing-setting-file/) provides an in-depth description of the Settings.xml file). +Timestamps (dates) can be used to set start date and end date of LISFLOOD simulation. Dates can be used for keys: StepStart, StepEnd and timestepInit in Settings.xml file. ReportSteps can only be provided as time steps numbers and are referred to CalendarDayStart ([Step 2: Preparing the Settings file](../3_step2_preparing-setting-file/index.md) provides an in-depth description of the Settings.xml file). If hours:minutes are not specified, LISFLOOD will automatically set them to 00:00 diff --git a/docs/3_step2_preparing-setting-file/index.md b/docs/3_step2_preparing-setting-file/index.md index 9ba96bf1..6c528f80 100644 --- a/docs/3_step2_preparing-setting-file/index.md +++ b/docs/3_step2_preparing-setting-file/index.md @@ -78,12 +78,12 @@ The 'lfuser' section starts with a number of constants that are related to the s - **DtSecChannel** is the simulation time interval used by the kinematic wave channel routing (in seconds). Using a value that is smaller than **DtSec** may result in a better simulation of the overall shape the calculated hydrograph (at the expense of requiring more computing time). -- **StepStart** is the date of the first time step in your simulation (defined according to [OS LISFLOOD time stamp convention](/2_ESSENTIAL_time-management/index.md)). +- **StepStart** is the date of the first time step in your simulation (defined according to [OS LISFLOOD time stamp convention](../3_step1_ESSENTIAL_concepts_to_get_started/index.md#time-convention-within-os-lisflood-model)). -- **StepEnd** is the date of the last time step in your simulation (defined according to [OS LISFLOOD time stamp convention](/2_ESSENTIAL_time-management/index.md)). +- **StepEnd** is the date of the last time step in your simulation (defined according to [OS LISFLOOD time stamp convention](../3_step1_ESSENTIAL_concepts_to_get_started/index.md#time-convention-within-os-lisflood-model)). **ReportSteps** defines the time step number(s) at which the model state (i.e. all maps that you would need to define the initial conditions of a succeeding model run) is written. -Note that this option only impacts the output frequency of the model state variables (activated by the "repStateMaps" option), not to the auxiliary variables. The full list of the affected variables is [here](../4_annex_state-variables). You can define this parameter in the following ways: +Note that this option only impacts the output frequency of the model state variables (activated by the "repStateMaps" option), not to the auxiliary variables. The full list of the affected variables is [here](../5_annex_state-variables/index.md). You can define this parameter in the following ways: 1) **At specific time steps**. If you like to have the state maps being written at certain time steps you can define those in a (comma separated) list. For example if you like to have the state maps for the time steps 10, 20 and 40, you need to write: @@ -520,7 +520,7 @@ OS LISFLOOD cold start run takes as input the OS LISFLOOD prerun output for the OS LISFLOOD warm start resumes the computations from the end states of a preceeding simulation (cold start or warm start). -A dedicated chapter about [model initialization](https://ec-jrc.github.io/lisflood-code/3_step5_model-initialisation/) provides more in-depth explanations of model prerun (initialization), cold start, and warm start. +A dedicated chapter about [model initialization](../3_step4_model-initialisation/index.md) provides more in-depth explanations of model prerun (initialization), cold start, and warm start. This page has the purpose to provide an overview of the variables requiring an initial value. Initial values shown in this page refer to a model prerrun simulation. @@ -665,7 +665,7 @@ This page has the purpose to provide an overview of the variables requiring an i - **CumIntSealedInitValue** is the initial value of the depression storage for the sealed part of a pixel $[mm]$ -- **LZInitValue** is the initial storage in the lower groundwater zone $[mm]$. In order to avoid initialization problems it is possible to let the model calculate a 'steady state' storage. Users are recommended to refer to the chapter on [model initialization](https://ec-jrc.github.io/lisflood-code/3_step5_model-initialisation/) +- **LZInitValue** is the initial storage in the lower groundwater zone $[mm]$. In order to avoid initialization problems it is possible to let the model calculate a 'steady state' storage. Users are recommended to refer to the chapter on [model initialization](../3_step4_model-initialisation/index.md) - **TotalCrossSectionAreaInitValue** is the initial cross-sectional area $[m^2]$ of the water in the river channels (a substitute for initial discharge, which is directly dependent on this). A value of **-9999 ** sets the initial amount of water in the channel to half bankfull. @@ -726,7 +726,7 @@ CumIntForestInitValue, UZForestInitValue, DSLRForestInitValue, ThetaForestInit1V ### Using options -The 'lfoptions' element (explained in [this page](../2_ESSENTIAL_setting-file/)) allows to activate or deactivate optional modules (e.g. the simulation of reservoirs), as well as to select the list of output files. +The 'lfoptions' element (explained in [this page](../3_step1_ESSENTIAL_concepts_to_get_started/index.md#os-lisflood-settings-file-settingsxml)) allows to activate or deactivate optional modules (e.g. the simulation of reservoirs), as well as to select the list of output files. The [LISFLOOD model documentation](https://ec-jrc.github.io/lisflood-model/) explains standard and optional modules. Optional modules and output variables are selected using switches: 1= on, 0=off. @@ -736,7 +736,7 @@ For instance, using the inflow hydrograph option requires an input map and time If you want to report discharge maps at each time step, you will first have to specify the writing path and desired file name. The [refernce xml settings file](https://github.com/ec-jrc/lisflood-code/blob/master/src/lisfloodSettings_reference.xml) includes definitions for most of the optional output maps and time series. -The use of the *output* options is described in detail in [a dedicated section](../4_annex_output-files/). +The use of the *output* options is described in detail in [a dedicated section](../5_annex_output-files/index.md). Within the 'lfoptions' element of the settings file, each option is defined using a 'setoption' element, which has the attributes 'name' and 'choice' (i.e. the actual value). For example: diff --git a/docs/3_step3_preparing-input-files/index.md b/docs/3_step3_preparing-input-files/index.md index 1299f641..532eceba 100644 --- a/docs/3_step3_preparing-input-files/index.md +++ b/docs/3_step3_preparing-input-files/index.md @@ -18,7 +18,7 @@ The meteorological forcing variables are defined in *map stacks*. A *map stack* Generally used prefixes for the meteorological forcings maps are:
+ tp : total precipitation; units: mm/day.
-+ ta : average temperature at 2m within the time computational step: degrees Celsius or Kelvin (the units must be specified in the [settings file](../3_step3_preparing-setting-file/))
++ ta : average temperature at 2m within the time computational step: degrees Celsius or Kelvin (the units must be specified in the [settings file](../3_step2_preparing-setting-file/index.md))
+ EW0 : reference value of evaporation from open water bodies; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
+ ES0 : reference value of evaporation from bare soil; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
+ ET0 : reference value of evapotranspiration; units: mm/day; these data can be prepared using [LISVAP](https://ec-jrc.github.io/lisflood-lisvap/).
@@ -65,7 +65,7 @@ The values on both maps may vary in space. A limitation is that a pixel is alway ``` -LISFLOOD settings files and the use of options are explained in detail in a [dedicated chapter](https://ec-jrc.github.io/lisflood-code/3_step3_preparing-setting-file/) and [annex](https://ec-jrc.github.io/lisflood-code/4_annex_settings_and_options/) of this document. +LISFLOOD settings files and the use of options are explained in detail in a [dedicated chapter](../3_step2_preparing-setting-file/index.md) and [annex](../5_annex_settings_and_options/index.md) of this document. #### Leaf area index maps diff --git a/docs/3_step4_model-initialisation/index.md b/docs/3_step4_model-initialisation/index.md index 35bed0d0..450cf794 100644 --- a/docs/3_step4_model-initialisation/index.md +++ b/docs/3_step4_model-initialisation/index.md @@ -14,10 +14,11 @@ A OS LISFLOOD simulation requires at least a prerun and a cold start. In some ca In this page we will: - 1. [demonstrate the effect of the model's initial states on simulation results](../3_step5_model-initialisation/index.md#the-impact-of-the-model-initial-state-on-simulation-results) - 2. [explain the theory of initialisation and the steady-state storage concept](../3_step5_model-initialisation/index.md#the-theory-of-initialisation-and-the-steady-state-storage-concept) - 3. [explain how to run the pre-run (initialization) for kinematic (kinematic and diffusive) and split routing (split routing and diffusive) routing configurations](../3_step5_model-initialisation/index.md#set-up-of-a-lisflood-prerun) - 4. [describe how to complete the initialisation in temporal chunks when needed](../3_step5_model-initialisation/index.md#set-up-of-a-lisflood-prerun-in-temporal-chunks) + + 1. [demonstrate the effect of the model's initial states on simulation results](../3_step4_model-initialisation/index.md#the-impact-of-the-model-initial-state-on-simulation-results) + 2. [explain the theory of initialisation and the steady-state storage concept](../3_step4_model-initialisation/index.md#the-theory-of-initialisation-and-the-steady-state-storage-concept) + 3. [explain how to run the pre-run (initialization) for kinematic (kinematic and diffusive) and split routing (split routing and diffusive) routing configurations](../3_step4_model-initialisation/index.md#setting-up-of-a-lisflood-prerun) + 4. [describe how to complete the initialisation in temporal chunks when needed](../3_step4_model-initialisation/index.md#setting-up-of-a-lisflood-prerun-in-temporal-chunks) @@ -61,7 +62,7 @@ To by-pass the need for excessively long spin-up periods, LISFLOOD is capable of The following paragraphs explain how the analytical solutions can be used to leverage on the **outputs of a OS LISFLOOD prerun** to adequately initialize volumetric soil moisture content and lower groundwater zone water content of a **OS LISFLOOD cold start**. -The complete list of initial state values for a **OS LISFLOOD prerun** is presented [here](https://github.com/ec-jrc/lisflood-code/blob/feature/docs/docs/3_step3_preparing-setting-file/index.md#initial-conditions-os-lisflood-prerun-cold-start-warm-start). The only relevant outputs of the OS LISFLOOD prerun are: +The complete list of initial state values for a **OS LISFLOOD prerun** is presented [here](../3_step2_preparing-setting-file/index.md#initial-conditions-os-lisflood-prerun-cold-start-warm-start). The only relevant outputs of the OS LISFLOOD prerun are: - end states of volumetric soil content and upper groundwater zone water content; - average fluxes values (from upper to lower soil layer, net inflow to the lower groundwater zone); - average discharge (when using SplitRouting). diff --git a/docs/3_step5_model-cold-warm-start-runs/index.md b/docs/3_step5_model-cold-warm-start-runs/index.md index 176efb7e..43ae463c 100644 --- a/docs/3_step5_model-cold-warm-start-runs/index.md +++ b/docs/3_step5_model-cold-warm-start-runs/index.md @@ -153,7 +153,7 @@ OS LISFLOOD "warm start" simulation resumes the computations from the end point >Reminder: prerun, cold start, and warm start simulations must always share the same set of parameters. -At the end of each model run, LISFLOOD writes maps of all internal state variables: the complete list of state variables is provided in [this Annex](../4_annex_state-variables). Two different sets of maps can be stored (simultaneously, in the output folder): +At the end of each model run, LISFLOOD writes maps of all internal state variables: the complete list of state variables is provided in [this Annex](../5_annex_state-variables/index.md). Two different sets of maps can be stored (simultaneously, in the output folder): - End maps: NetCDF single maps containing internal state variables values for the last simulation timestep (*StepEnd*) - State maps: NetCDF stack maps containing internal state variables values for the *ReportSteps* period diff --git a/docs/3_step6_model-output/index.md b/docs/3_step6_model-output/index.md index 63293f4e..08e6982d 100644 --- a/docs/3_step6_model-output/index.md +++ b/docs/3_step6_model-output/index.md @@ -7,13 +7,13 @@ For instance, maps of **discharge** at each time step are generated by using A number of output files are specific to optional modules, such as the simulation of reservoirs. -The users can manage the steps reported in the output maps via the 'ReportSteps' key of the settings .xml file: the list of options and the relevant instructions can be found [here](../3_step3_preparing-setting-file/index.md#time-related-constants). +The users can manage the steps reported in the output maps via the 'ReportSteps' key of the settings .xml file: the list of options and the relevant instructions can be found [here](../3_step2_preparing-setting-file/index.md#time-related-constants). **State maps** Output state maps are reported when switching on the option *repStateMaps=1* (note that the file names can always be changed by the user, although this is not recommended). These maps can be used to define the initial conditions of a succeeding simulation.  -A full list of state maps can be found [here](../4_annex_state-variables) +A full list of state maps can be found [here](../5_annex_state-variables/index.md) To speed up the pre-run, with ‘InitLisflood’ = 1 the output is limited to the maps required for the initialization of the cold start or when performing the prerun in temporal chunks. @@ -43,4 +43,4 @@ Time series file have *.tss* extension and they can be opened with any text edit It is important to be aware of the spatial domain for which each time series is computed. For instance, 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. -This [**Annex**](../4_annex_output-files/) summarises most of the options to report additional output maps. +This [**Annex**](../5_annex_output-files/index.md) summarises most of the options to report additional output maps. diff --git a/docs/4_Static-Maps-introduction/index.md b/docs/4_Static-Maps-introduction/index.md index b80824c0..e370222e 100644 --- a/docs/4_Static-Maps-introduction/index.md +++ b/docs/4_Static-Maps-introduction/index.md @@ -8,7 +8,7 @@ Maps can be elaborated with any GIS/remote sensing software. Examples in this gu ## Projection and file type -All static input maps for LISFLOOD need to have the same model domain, projection, resolution – same number of columns and rows, and same grid of coordinates (i.e. all 4 corners of each pixel must have exactly the same coordinates in degrees or in meters, depending on the reference system). This is a strict requirement of the [LISFLOOD model](https://github.com/ec-jrc/lisflood-code) (here and below ‘the LISFLOOD model’ refers to the version 3.1.0) that at present cannot accept input maps at different spatial resolution or geographical extension.
+All static input maps for LISFLOOD need to have the same model domain, projection, resolution – same number of columns and rows, and same grid of coordinates (i.e. all 4 corners of each pixel must have exactly the same coordinates in degrees or in meters, depending on the reference system). This is a strict requirement of the [LISFLOOD model](https://github.com/ec-jrc/lisflood-code).
All maps should be introduced in the model in NetCDF or PCRaster file format. This user guide provides the examples for the European and Global domains that are being used in EFAS and GloFAS models, respectively. The static fields structure for EFAS and GloFAS is the following:
diff --git a/docs/4_Static-Maps_reservoirs-lakes/index.md b/docs/4_Static-Maps_reservoirs-lakes/index.md index 87697f1b..77d4f8cc 100644 --- a/docs/4_Static-Maps_reservoirs-lakes/index.md +++ b/docs/4_Static-Maps_reservoirs-lakes/index.md @@ -62,7 +62,7 @@ Essential information are: 1. reservoir unique identifier, selected by the user or taken from external datasets; 2. Geographic oordinates of the reservoir outlet; -3. Coordinates of the reservoir outlet mapped on OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)); +3. Coordinates of the reservoir outlet mapped on OS LISFLOOD local drainage direction map ([ldd](../4_Static-Maps_topography/index.md)); 4. Reservoir storage capacity; 5. Reservoir normal outflow; 6. Reservoir minimum ouflow; @@ -82,7 +82,7 @@ Optional metadata are: The following paragraphs provide guidelines for the generation of the reservoir map and tables. -Reservoir unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the reservoirs map. Geographic oordinates of the reservoirs outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3). Adequate model representation requires the agreement between reservoir catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/). +Reservoir unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](../4_Static-Maps_topography/index.md)) (3) are required to generate the reservoirs map. Geographic oordinates of the reservoirs outlet (2) and OS LISFLOOD local drainage direction map ([ldd](../4_Static-Maps_topography/index.md)) are essential to generate (3). Adequate model representation requires the agreement between reservoir catchment area (7) and OS LISFLOOD [upstream area map](../4_Static-Maps_topography/index.md). Reservoir storage capcaity can be retrieved from local datasets or global datasets such as [GDW](https://www.globaldamwatch.org/grand). @@ -119,7 +119,7 @@ Essential information are: 1. Lake unique identifier, selected by the user or taken from external datasets; 2. Geographic oordinates of the lake outlet; -3. Coordinates of the lake outlet mapped on OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)); +3. Coordinates of the lake outlet mapped on OS LISFLOOD local drainage direction map ([ldd](../4_Static-Maps_topography/index.md)); 4. Lake surface area; 5. Lake outlet width; 6. Average inflow to the lake. @@ -135,7 +135,7 @@ Optional metadata are: The following paragraphs provide guidelines for the generation of the lake map and tables. -Lake unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) (3) are required to generate the lake map. Geographic oordinates of the lake outlet (2) and OS LISFLOOD local drainage direction map ([ldd](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/)) are essential to generate (3). Adequate model representation requires the agreement between lake catchment area (7) and OS LISFLOOD [upstream area map](https://ec-jrc.github.io/lisflood-code/4_Static-Maps_topography/). +Lake unique identifier (1) and coordinates of the outlet mapped on the OS LISFLOOD local drainage direction map ([ldd](../4_Static-Maps_topography/index.md)) (3) are required to generate the lake map. Geographic oordinates of the lake outlet (2) and OS LISFLOOD local drainage direction map ([ldd](../4_Static-Maps_topography/index.md)) are essential to generate (3). Adequate model representation requires the agreement between lake catchment area (7) and OS LISFLOOD [upstream area map](../4_Static-Maps_topography/index.md). Lake surface area can be retrieved from local datasets or global datasets such as HydroLAKES](https://www.hydrosheds.org/products/hydrolakes), [GLWD](https://www.hydrosheds.org/products/glwd), [GRAND](https://www.globaldamwatch.org/grand). diff --git a/docs/4_Static-Maps_water-use/index.md b/docs/4_Static-Maps_water-use/index.md index 027cc558..adeac0ca 100644 --- a/docs/4_Static-Maps_water-use/index.md +++ b/docs/4_Static-Maps_water-use/index.md @@ -37,7 +37,7 @@ The [Groundwater Resources of the World](https://www.whymap.org/whymap/EN/Maps_D Global 3 arcmin groundwater bodies map was produced leveraging on two datasets: [Groundwater Resources of the World](https://www.whymap.org/whymap/EN/Maps_Data/Gwr/gwr_node_en.html) and the global map of bedrock elevation [GDEMM2024](https://www.nature.com/articles/s41597-024-03920-x). Albeit the first dataset was specifcally derived to highlight exploitable groundwater resources, the use of GDEMM2024 was considered useful to ensure the consistency between the global map of groudwater bodies and the available information on country-level groundwater abstraction (more details in the section **Sectoral water demand maps**). It was decided to ensure the presence of at least one groundwater pixel in all countries that reported some groundwater abstraction. According to this approach, exploitable groudwater bodies in the global 3arcmin map have larger extent than the data shown in the Groundwater Resources of the World. It is of parmount importance to acknowledge the uncertainty of the source data for the generation of water withdrawal and releated maps: the first version of the global 3arcmin map prioritized the consistency with country level data of water withdrawal (**Sectoral water demand maps**). European 1 arcmin groundwater bodies map was generated using the [International Hydrogeological Map of Europe, IHME1500](https://www.bgr.bund.de/EN/Themen/Grundwasser/Projekte/Flaechen-Rauminformationen/Ihme1500/ihme1500.html) v 1.2 as main data source. Specifically, groundwater resources were deemed available for the areas belonging to the following classes: *I. Predominally porous rocks; II. Predominnally fissured rocks, including karstified rocks; IIIa. Locally acquiferous rocks*. This approach satisfied the cross-check with available information on country level water abstraction from groundwater (for details, please see **Sectoral water demand maps**). -Groundwater bodies of areas of the European extended domain (as defined in the [introduction to the static maps](https://ec-jrc.github.io/lisflood-code/4_Static-Maps-introduction/)) not covered by IHME1500 were derived from the global map of groundwater bodies. To avoid abrupt discontinuities, the two datasets were merged at the country level. +Groundwater bodies of areas of the European extended domain (as defined in the [introduction to the static maps](../4_Static-Maps-introduction/index.md)) not covered by IHME1500 were derived from the global map of groundwater bodies. To avoid abrupt discontinuities, the two datasets were merged at the country level. ### Fraction of water abstraction from groundwater, surface water, non-conventional resources OS LISFLOOD allows water abstraction from groundwater, surface water, non-conventional sources (e.g. desalinization plants). The maps fraction of water abstraction from groundwater (fracgroundwateruse) and fraction of water abstraction from non-conventional sources (fracnonconventionalwateruse) provide information on the proportion of the total water demand that must be provided by groundwater resources and non-conventional water sources, respectively. diff --git a/docs/5_annex_output-files/index.md b/docs/5_annex_output-files/index.md index a0f716a4..b12ced0d 100644 --- a/docs/5_annex_output-files/index.md +++ b/docs/5_annex_output-files/index.md @@ -172,7 +172,7 @@ To speed up the pre-run and to prevent that results are taken from the pre-run, *LISFLOOD state maps* are the maps can be used to define the initial conditions of another simultion (warm start). 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/5_annex_state-variables/ . +The complete list of state maps is available [here](../5_annex_state-variables/index.md). The users should be aware that some state maps are generated only if the relevant option has been set to 1. For instance, LakePrevInflowState and LakePrevOutflowState can be generated only when 'simulateLakes' = 1. diff --git a/docs/5_annex_settings_and_options/index.md b/docs/5_annex_settings_and_options/index.md index a141b272..f04b4e35 100644 --- a/docs/5_annex_settings_and_options/index.md +++ b/docs/5_annex_settings_and_options/index.md @@ -2,10 +2,10 @@ This annex presents a nearly comprehensive list of setting options, inputs, and The content is organized in the following tables: -- [**lfoptions**](../4_annex_settings_and_options/index.md#table-lfoptions-section-in-os-lisflood-settings-xml): list of available switches to activate optional modules and optional outputs (time series and map formats) -- [**luser**](../4_annex_settings_and_options/index.md#table-lfuser-in-os-lisflood-settings-xml): list of variables which are generally defined by the users. -- [**lfbinding**](../4_annex_settings_and_options/index.md#table-lfbinging-section-in-os-lisflood-settings-xml): list of model variables. -- [**initial variables**](../4_annex_settings_and_options/index.md#table-variables-required-for-model-initialization): list of variables required for model initialization. The table indicates values/maps required by the cold and warm start of both prerun and run) +- [**lfoptions**](../5_annex_settings_and_options/index.md#table-lfoptions-section-in-os-lisflood-settings-xml): list of available switches to activate optional modules and optional outputs (time series and map formats) +- [**luser**](../5_annex_settings_and_options/index.md#table-lfuser-in-os-lisflood-settings-xml): list of variables which are generally defined by the users. +- [**lfbinding**](../5_annex_settings_and_options/index.md#table-lfbinging-section-in-os-lisflood-settings-xml): list of model variables. +- [**initial variables**](../5_annex_settings_and_options/index.md#table-variables-required-for-model-initialization): list of variables required for model initialization. The table indicates values/maps required by the cold and warm start of both prerun and run) ## **Table:** *lfoptions section in OS LISFLOOD settings xml* diff --git a/docs/_config.yml b/docs/_config.yml index 9d9d8412..ea3dd2a1 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -214,8 +214,8 @@ defaults: url: 3_step5_model-cold-warm-start-runs - title: "Step 6: model output" url: 3_step6_model-output - - title: "Step 7: commmand line flags" - url: 3_step7_commmand-line-flags + - title: "Step 7: command line flags" + url: 3_step7_command-line-flags - section_title: "Static maps" items: