Settings
Settings are managed in the FM2PROF Configuration file
Input
2DMapOutput
Output file from FM2D model (.net file)
| Input | Value |
|---|---|
| Type | str |
| Default value |
CrossSectionLocationFile
.csv or .txt file (, as delimiter) that contains four columns: X_coordinate,Y_coordinate,BranchName,Length,Chainage.
| Input | Value |
|---|---|
| Type | str |
| Default value |
RegionPolygonFile
User defined polygons in json format
| Input | Value |
|---|---|
| Type | str |
| Default value |
SectionPolygonFile
User defined polygons in json format
| Input | Value |
|---|---|
| Type | str |
| Default value |
Parameters
CaseName
Subdirectory name under OutputDir (no space); if not specified, 'CaseXX' (01, 02..) are used
| Input | Value |
|---|---|
| Type | str |
| Default value |
MaximumPointsInProfile
Number of points which are used to generate cross-sections
| Input | Value |
|---|---|
| Type | int |
| Default value | 20 |
ConveyanceDetectionMethod
[0] method based on mean flow velocity, [1] method based on maximum flow velocity (default)
| Input | Value |
|---|---|
| Type | int |
| Default value | 1 |
AbsoluteVelocityThreshold
Absolute velocity threshold in m/s. Used to determine storage
| Input | Value |
|---|---|
| Type | float |
| Default value | 0.1 |
RelativeVelocityThreshold
Relative velocity threshold (percentage). Used to determine storage
| Input | Value |
|---|---|
| Type | float |
| Default value | 0.15 |
MinimumDepthThreshold
Minimum depth (m) for storage identification
| Input | Value |
|---|---|
| Type | float |
| Default value | 0.02 |
BedlevelCriterium
Ignore the lowest percentage of bed level points
| Input | Value |
|---|---|
| Type | float |
| Default value | 0.05 |
LakeTimesteps
Number of timesteps that are used for identifying lakes
| Input | Value |
|---|---|
| Type | int |
| Default value | 10 |
ExtrapolateStorage
Add storage to water level independent cross-section section
| Input | Value |
|---|---|
| Type | fm2prof.ini_file.ImportBoolType |
| Default value | True |
SDCorrection
Use summerdike volume correction
| Input | Value |
|---|---|
| Type | fm2prof.ini_file.ImportBoolType |
| Default value | True |
SDFloodplainBase
minimum distance between floodplain base level and crest level in meters
| Input | Value |
|---|---|
| Type | float |
| Default value | 0.5 |
SDTransitionHeight
Transition height at the summer dike (m)
| Input | Value |
|---|---|
| Type | float |
| Default value | 0.5 |
SDOptimisationMethod
[0] Optimise on Total volume, [1] optimise on flow volume, [2] optimise on both
| Input | Value |
|---|---|
| Type | int |
| Default value | 0 |
FrictionWeighingMethod
Options. [0] arithmetric mean, [1] Weighted average
| Input | Value |
|---|---|
| Type | int |
| Default value | 0 |
SkipMaps
number of timesteps to skip at begin of 2D output. Use to skip problems related to initial conditions.
| Input | Value |
|---|---|
| Type | int |
| Default value | 0 |
MinimumTotalWidth
Minimum width in meters. Zero width may lead to numerical instability in 1D solvers
| Input | Value |
|---|---|
| Type | float |
| Default value | 0.5 |
DefaultSection
Default section name to use in cells not covered by a section polygon. Value options: floodplain1, floodplain2 or main
| Input | Value |
|---|---|
| Type | str |
| Default value | floodplain1 |
DefaultRegion
Default region name to use in cells not covered by a region polygon.
| Input | Value |
|---|---|
| Type | str |
| Default value | undefined |
Debug
ExportCSSData
If True, exports pickled (1) input data for cross-section object, (2) flow mask for conveyance/storage.
| Input | Value |
|---|---|
| Type | fm2prof.ini_file.ImportBoolType |
| Default value | False |
ExportMapFiles
Export detailed map output. Only use for small models or limited number of cross-sections b/c output can be huge.
| Input | Value |
|---|---|
| Type | fm2prof.ini_file.ImportBoolType |
| Default value | False |
CssSelection
provide comma separated list of ints; e.g. 38, 39, 40. Leave empty to generate all cross-sections
| Input | Value |
|---|---|
| Type | fm2prof.ini_file.ImportListType |
| Default value |
Output
OutputDirectory
Output files are saved in OutputDir/CaseName; if not specified, subdirectory is created in the current directory
| Input | Value |
|---|---|
| Type | str |
| Default value | output |