MDU file¶
The MDU file is the main input file for D-Flow FM. It is represented by the classes below.
Model¶
AutoStartOption (IntEnum)
¶
Enum class containing the valid values for the AutoStart attribute in the [General][hydrolib.core.dflowfm.mdu.models.General] class.
Calibration (INIBasedModel)
pydantic-model
¶
The [Calibration] section in an MDU file.
This model is typically referenced under FMModel.calibration.
All lowercased attributes match with the [Calibration] input as described in UM Sec.A.3.
ExternalForcing (INIBasedModel)
pydantic-model
¶
The [External Forcing] section in an MDU file.
This model is typically referenced under FMModel.external_forcing.
All lowercased attributes match with the [External Forcing] input as described in UM Sec.A.1.
is_intermediate_link(self) -> bool
¶
Generic attribute for models that have children fields that could contain files.
Source code in hydrolib/core/dflowfm/mdu/models.py
def is_intermediate_link(self) -> bool:
return True
FMModel (INIModel)
pydantic-model
¶
The overall FM model that contains the contents of the toplevel MDU file.
All lowercased attributes match with the supported "[section]"s as described in UM Sec.A.
Each of these class attributes refers to an underlying model class for that particular section.
Geometry (INIBasedModel)
pydantic-model
¶
The [Geometry] section in an MDU file.
This model is typically referenced under FMModel.geometry.
All lowercased attributes match with the [Geometry] input as described in UM Sec.A.1.
is_intermediate_link(self) -> bool
¶
Generic attribute for models that have children fields that could contain files.
Source code in hydrolib/core/dflowfm/mdu/models.py
def is_intermediate_link(self) -> bool:
return True
GroundWater (INIBasedModel)
pydantic-model
¶
The [Grw] section in an MDU file.
This model is typically referenced under FMModel.grw.
All lowercased attributes match with the [Grw] input as described in UM Sec.A.3.
Hydrology (INIBasedModel)
pydantic-model
¶
The [Hydrology] section in an MDU file.
This model is typically referenced under FMModel.hydrology.
All lowercased attributes match with the [Hydrology] input as described in UM Sec.A.1.
InfiltrationMethod (IntEnum)
¶
Enum class containing the valid values for the Infiltrationmodel attribute in the [Groundwater][hydrolib.core.dflowfm.mdu.models.Groundwater] class.
Numerics (INIBasedModel)
pydantic-model
¶
The [Numerics] section in an MDU file.
This model is typically referenced under FMModel.numerics.
All lowercased attributes match with the [Numerics] input as described in UM Sec.A.1.
Output (INIBasedModel)
pydantic-model
¶
The [Output] section in an MDU file.
This model is typically referenced under FMModel.output.
All lowercased attributes match with the [Output] input as described in UM Sec.A.1.
is_intermediate_link(self) -> bool
¶
Generic attribute for models that have children fields that could contain files.
Source code in hydrolib/core/dflowfm/mdu/models.py
def is_intermediate_link(self) -> bool:
return True
Particles (INIBasedModel)
pydantic-model
¶
The [Particles] section in an MDU file.
This model is typically referenced under FMModel.particles.
All lowercased attributes match with the [Particles] input as described in UM Sec.A.3.
ParticlesThreeDType (IntEnum)
¶
Enum class containing the valid values for the 3Dtype
attribute in the Particles class.
Physics (INIBasedModel)
pydantic-model
¶
The [Physics] section in an MDU file.
This model is typically referenced under FMModel.physics.
All lowercased attributes match with the [Physics] input as described in UM Sec.A.1.
ProcessFluxIntegration (IntEnum)
¶
Enum class containing the valid values for the ProcessFluxIntegration attribute in the Processes class.
Processes (INIBasedModel)
pydantic-model
¶
The [Processes] section in an MDU file.
This model is typically referenced under FMModel.processes.
All lowercased attributes match with the [Processes] input as described in UM Sec.A.3.
Restart (INIBasedModel)
pydantic-model
¶
The [Restart] section in an MDU file.
This model is typically referenced under FMModel.restart.
All lowercased attributes match with the [Restart] input as described in UM Sec.A.1.
Time (INIBasedModel)
pydantic-model
¶
The [Time] section in an MDU file.
This model is typically referenced under FMModel.time.
All lowercased attributes match with the [Time] input as described in UM Sec.A.1.
Trachytopes (INIBasedModel)
pydantic-model
¶
The [Trachytopes] section in an MDU file.
This model is typically referenced under FMModel.trachytopes.
All lowercased attributes match with the [Trachytopes] input as described in UM Sec.A.1.
Vegetation (INIBasedModel)
pydantic-model
¶
The [Veg] section in an MDU file.
This model is typically referenced under FMModel.veg.
All lowercased attributes match with the [Veg] input as described in UM Sec.A.3.
VegetationModelNr (IntEnum)
¶
Enum class containing the valid values for the VegetationModelNr attribute in the Vegetation class.
VolumeTables (INIBasedModel)
pydantic-model
¶
The [VolumeTables] section in an MDU file.
This model is typically referenced under FMModel.volumetables.
All lowercased attributes match with the [VolumeTables] input as described in UM Sec.A.1.
Waves (INIBasedModel)
pydantic-model
¶
The [Waves] section in an MDU file.
This model is typically referenced under FMModel.waves.
All lowercased attributes match with the [Waves] input as described in UM Sec.A.1.
Wind (INIBasedModel)
pydantic-model
¶
The [Wind] section in an MDU file.
This model is typically referenced under FMModel.wind.
All lowercased attributes match with the [Wind] input as described in UM Sec.A.1.