Skip to content
GitLab

user_documentation · Changes

Page history
added description of damage functions in user doc authored by rolo's avatar rolo
Hide whitespace changes
Inline Side-by-side
user_documentation.md
View page @ 60357ddf
......@@ -14,18 +14,58 @@ For reading flood results from the DHI formats dfs2 and dfsu, additional librari
* Finally, reading results from dfs2 files currently requires that arcpy is available on the computer, i.e., ArcGIS must be installed. ArcPy is used to compute projected coordinates from the geographic coordinates saved in the dfs2 format.
# Configuration
The program input can (to some extent) be configured through an xml file saved under ./config/config_damage.xml. The file includes the following input parameters:
The program input can (to some extent) be configured through an xml file saved under ./config/config_damage.xml. The file can be opened with any text editor (Notepad++ gives nice highlighting) and includes the following input parameters:
1. WORKPATH - This is the path were the temporary working directory and the result file will be created.
2. RESFILE - This is the path to the raster/dfs2/dfsu file containing the max flood map.
3. BUILDINGS - This is the path to a GIS file containing building features used for damage computation. This file must have a specific format, see Input Data Specification.
3. BUILDINGS - This is the path to a GIS file containing building features used for damage computation. This file must have a specific format, see Input Data Specification. In addition, under "typefield", the user can specify the name of the (text-based) attribute column in the building layer which is used to specify the building type. Different depth damage functions are applied for each building type and must be provided under "damagefunc".
4. ROADS - This is the path to a GIS file containing road features used for damage computation. This file must have a specific format, see Input Data Specification.
5. GREEN - This is the path to a GIS file containing green area features used for damage computation. This file must have a specific format, see Input Data Specification.
6. EXTENT - This is the path to a GIS file containing a single polygon marking the area for which damage computation should be performed. See Input Data Specification.
7. damagefunc - This section contains the depth-damage functions applied. It is separated into subsections containing different functions for buildings, roads and green areas. The building section is further subdivided into subsections for residential, public and commercial buildings.
8. software
8. software - This section contains the paths to the MIKE SDK libraries (needed for reading dfs2 and dfsu) and to the ArcGIS installation (needed when reading dfs2).
# Input Data Specification
## Files Characterizing Land Use
Currently, the program expects land use data as shapefiles. Functions for reading vector layers from SQLite databases are implemented in the code, but not activated at the moment. The following input layers are required:
### Buildings
Buildings must be provided as polygon layers and should include an attribute field of type "text", characterizing the type of building. Three building types are implemented in the default configuration file ("RES","COM","PUB"), but different type names can be used by changing the tags in section "damagefunc/BUILDINGS" in the configuration file.
Additional building types can be included in the computation by including additional <type></type> sections under "damagefunc/BUILDINGS" in the configuration file.
Similarly, the user can choose to consider fewer types of buildings by removing <type> sections from the configuration.
### Roads
Roads should be provided as polygon layers, but no attributes are required. Damages are computed per sqm of flooded road area.
### Green Areas
Green areas should be provided as polygon layers, but no attributes are required. Damages are computed per sqm of flooded green area.
## Depth Damage Functions
Depth damage functions are specified in the configuration file in the form (water level 1, water level 2, ...) (damage 1, damage 2, ...). For buildings, damage functions are specified per building, i.e., they only depend on the type of building, but not on its size. For roads and green areas, damage functions are specified per sqm of area flooded above a given threshold.
For example, the default configuration file contains the following damage function specification for residential buildings:
```XML
<BUILDINGS>
<type>
<tag>RES</tag>
<level>0;0.1;15</level>
<damage>0;13500;13500</damage>
</type>
</BUILDINGS>
```
This specification translates into a damage function where 0 damage occurs if a residential building is flooded with a depth between 0 and 0.1m, while flood depths between 0.1 and 15m incurr a unit damage of 13,500 Dollars (or any other currency of your liking).
For roads, the following function is specified:
```XML
<ROADS>
<type>
<tag>ROADS</tag>
<level>0.3</level>
<damagepsqm>80</damagepsqm>
</type>
</ROADS>
```
This specification translates into a damage function where 0 damage occurs if a road is flooded with a depth between 0 and 0.3m, while all higher flood depths incurr a per sqm damage of 80 Dollars (or any other currency of your liking).
# Running the program
......