Summary ini
-file
This page gives an overview and summary of all possible entries in the ini-file of the model.
The ini-file is a configuration file where all model options are controlled.
For each input in the ini
-file, this overview defines:
NAME: the name (key) of the variable
DTYPE: the data type of the variable
DEFAULT: the default value (if available)
MODEL PART: the model part for which this is relevant (R = Routing algorithm, WS = WaTEM/SEDEM, CN = Curved Number)
REQUIREMENT: The requirement of the variable (M = mandatory, C = conditionally mandatory, O = optional)
Overview
Note
Note that in the ini-file the headers (given in [ ]) should also be included.
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
str |
‘’ |
R, WS, CN |
M |
|
str |
‘’ |
R, WS, CN |
O |
[Files]
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
str |
R, WS, CN |
M |
||
str |
R, WS, CN |
M |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
M |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
R, WS, CN |
C |
||
str |
CN |
M |
||
str |
R, WS, CN |
C |
||
str |
WS, CN |
C |
||
str |
WS, CN |
C |
||
str |
WS, CN |
M |
||
str |
WS, CN |
M |
||
str |
WS, CN |
C |
[Options]
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
boolean |
false |
R |
O |
|
boolean |
false |
WS, CN |
O |
|
str |
Desmet1996_Vanoost2003 |
R, WS, CN |
M |
|
str |
Nearing1997 |
R, WS, CN |
M |
|
str |
VanOost2000 |
R, WS, CN |
M |
[Output]
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
WS, CN |
O |
|
boolean |
false |
WS, CN |
O |
|
boolean |
false |
WS, CN |
O |
|
boolean |
false |
CN |
O |
|
boolean |
false |
CN |
O |
|
boolean |
false |
WS, CN |
O |
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
float |
‘’ |
WS |
M |
|
int |
‘’ |
WS, CN |
M |
|
int |
‘’ |
R, WS, CN |
M |
|
int |
‘100’ |
R, WS, CN |
M |
|
int |
‘’ |
R, WS, CN |
M |
|
int |
‘’ |
R, WS, CN |
M |
|
int |
‘’ |
R, WS, CN |
M |
|
int |
50 |
R, WS, CN |
O |
|
int |
100 |
R, WS, CN |
O |
|
int |
‘’ |
WS, CN |
M |
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
boolean |
false |
WS |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
WS, CN |
O |
|
boolean |
false |
WS, CN |
O |
|
boolean |
false |
WS, CN |
C |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
|
Convert output |
boolean |
false |
R, WS, CN |
O |
boolean |
false |
R, WS, CN |
O |
|
boolean |
false |
R, WS, CN |
O |
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
int |
‘’ |
R, WS, CN |
C |
|
float |
‘’ |
R, WS, CN |
C |
|
float |
‘’ |
CN |
C |
|
float |
‘’ |
CN |
M |
|
float |
‘’ |
CN |
M |
|
float |
‘’ |
CN |
M |
|
float |
‘1’ |
R, WS, CN |
M |
|
int |
‘’ |
R, WS, CN |
C |
|
int |
‘’ |
R, WS, CN |
C |
|
float |
‘’ |
WS, CN |
C |
|
float |
‘’ |
WS, CN |
C |
|
float |
‘’ |
WS, CN |
C |
|
int |
‘’ |
WS, CN |
C |
|
float |
‘’ |
WS, CN |
C |
|
int |
‘’ |
CN |
M |
|
int |
‘’ |
CN |
C |
|
int |
‘’ |
CN |
M |
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
float |
5 |
R, WS, CN |
C |
|
float |
40 |
R, WS, CN |
C |
|
float |
1 |
R, WS, CN |
C |
|
float |
20 |
R, WS, CN |
C |
|
int |
12 |
R, WS, CN |
C |
This section is only mandatory when Force Routing is enabled. The section is repeated for every force routing vector (i.e. X ranges from 1 to Number of forced routing.
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
from col |
int |
‘’ |
R, WS, CN |
M |
from row |
int |
‘’ |
R, WS, CN |
M |
target col |
int |
‘’ |
R, WS, CN |
M |
target row |
int |
‘’ |
R, WS, CN |
M |
This section is only mandatory when Include buffers is enabled. The section is repeated for every buffer id (i.e. X ranges from 1 to Number of buffers).
NAME |
DTYPE |
DEFAULT |
MODEL PART |
REQUIREMENT |
---|---|---|---|---|
Volume |
float |
‘’ |
R, WS, CN |
C |
Height dam |
float |
‘’ |
R, WS, CN |
C |
Height opening |
float |
‘’ |
R, WS, CN |
C |
Opening area |
float |
‘’ |
R, WS, CN |
C |
Discharge coefficient |
float |
‘’ |
R, WS, CN |
C |
Width dam |
float |
‘’ |
R, WS, CN |
C |
Trapping efficiency |
float |
‘’ |
R, WS, CN |
M |
Extension ID |
int |
‘’ |
R, WS, CN |
M |
Conditionally mandatory Dependencies (C)
The format is currently: if … > then … mandatory. These do not include the model part requirements, as these can be derived from the table itself.
Include_sewer > Sewer exit and Sewer map filename
Calculate Tillage Erosion > Create ktil map and ktil map filename
*NOT* Create ktil map> ktil map filename
*NOT* calibrate *AND NOT* Create ktc map > ktc map filename
Include tillage direction > Tillage direction filename and Oriented roughness filename
Include buffers > Buffer map filename and Number of buffers
Include ditches > Ditch map filename
Include dams > Dam map filename
River Routing > River segment filename, adjectant segments, upstream segments and river routing filename
Output per river segment > River segment filename
*NOT* Use R factor > Rainfall filename and 5|day antecedent rainfall
Estimate clay content > Clay content parent material
Manual outlet selection > Outlet map filename
Force Routing > Number of Forced Routing
*NOT* calibrate AND Create ktc map > ktc low and ktc high
Create ktc map > ktc limit
calibrate > ktc limit, KTcHigh_lower, KTcHigh_upper, KTcLow_lower, KTcLow_upper and steps
Create ktil map > ktil default and ktil threshold
Convert output > Final timestep output
Controlled vocabularies
Some variables require specific input strings (keys) in order to select the right method for the calculations in the model. The variables and their respective posible keys are listed hereunder:
L model -> Desmet1996_McCool or Desmet1996_Vanoost2003
S model -> Desmet1996 or Nearing1997
TC model -> VanOost2000 or Verstraeten2007