Skip to content

FM2PROF configuration

input

2DMapOutput

type: str

default value: None

Output file from FM2D model (.net file)

CrossSectionLocationFile

type: str

default value: None

.csv or .txt file (, as delimiter) that contains four columns: X_coordinate,Y_coordinate,BranchName,Length,Chainage.

RegionPolygonFile

type: str

default value: None

User defined polygons in json format

SectionPolygonFile

type: str

default value: None

User defined polygons in json format

parameters

CaseName

type: str

default value: None

Subdirectory name under OutputDir (no space); if not specified, 'CaseXX' (01, 02..) are used

MaximumPointsInProfile

type: int

default value: None

Number of points which are used to generate cross-sections

ConveyanceDetectionMethod

type: int

default value: None

[0] method based on mean flow velocity, [1] method based on maximum flow velocity (default)

AbsoluteVelocityThreshold

type: float

default value: None

Absolute velocity threshold in m/s. Used to determine storage

RelativeVelocityThreshold

type: float

default value: None

Relative velocity threshold (percentage). Used to determine storage

MinimumDepthThreshold

type: float

default value: None

Minimum depth (m) for storage identification

BedlevelCriterium

type: float

default value: None

Ignore the lowest percentage of bed level points

LakeTimesteps

type: int

default value: None

Number of timesteps that are used for identifying lakes

ExtrapolateStorage

type: fm2prof.IniFile.ImportBoolType

default value: None

Add storage to water level independent cross-section section

SDCorrection

type: fm2prof.IniFile.ImportBoolType

default value: None

Use summerdike volume correction

SDFloodplainBase

type: float

default value: None

minimum distance between floodplain base level and crest level in meters

SDTransitionHeight

type: float

default value: None

Transition height at the summer dike (m)

SDOptimisationMethod

type: int

default value: None

[0] Optimise on Total volume, [1] optimise on flow volume, [2] optimise on both

FrictionWeighingMethod

type: int

default value: None

Options. [0] arithmetric mean, [1] Weighted average

SkipMaps

type: int

default value: None

number of timesteps to skip at begin of 2D output. Use to skip problems related to initial conditions.

ClassificationMethod

type: int

default value: None

How to classify 2D output using Section and Region polygons. Options: [0] Do not classify regions or sections. [1] Use DeltaShell

MinimumTotalWidth

type: float

default value: None

Minimum width in meters. Zero width may lead to numerical instability in 1D solvers

debug

ExportCSSData

type: fm2prof.IniFile.ImportBoolType

default value: None

If True, exports pickled (1) input data for cross-section object, (2) flow mask for conveyance/storage.

ExportMapFiles

type: fm2prof.IniFile.ImportBoolType

default value: None

Export detailed map output. Only use for small models or limited number of cross-sections b/c output can be huge.

CssSelection

type: fm2prof.IniFile.ImportListType

default value: None

provide comma separated list of ints; e.g. 38, 39, 40. Leave empty to generate all cross-sections

output

OutputDirectory

type: str

default value: None

Output files are saved in OutputDir/CaseName; if not specified, subdirectory is created in the current directory