Skip to content

External forcings file

The external forcing .ext file contains the forcing data for a D-Flow FM model. This includes open boundaries, lateral discharges and meteorological forcings. The documentation below only concerns the 'old' format (ExtForceFile in the MDU file).

Model

ExtOldExtrapolationMethod (IntEnum)

Enum class containing the valid values for the extrapolation_method attribute in the ExtOldForcing class.

NoSpatialExtrapolation

  1. No spatial extrapolation.

SpatialExtrapolationOutsideOfSourceDataBoundingBox

  1. Do spatial extrapolation outside of source data bounding box.

ExtOldFileType (IntEnum)

Enum class containing the valid values for the filetype attribute in the ExtOldForcing class.

ArcInfo

  1. ArcInfo

CurvilinearData

  1. Space-time data on curvilinear grid

NetCDFGridData

  1. NetCDF grid data (e.g. meteo fields)

NetCDFWaveData

  1. NetCDF wave data

Polyline

  1. Polyline (<*.pli>-file)

Samples

  1. Samples

SpatiallyVaryingWindPressure

  1. Spatially varying wind and pressure

SpiderWebData

  1. Spiderweb data (cyclones)

TimeSeries

  1. Time series

TimeSeriesMagnitudeAndDirection

  1. Time series magnitude and direction

TriangulationMagnitudeAndDirection

  1. Triangulation magnitude and direction

ExtOldForcing (BaseModel) pydantic-model

Class holding the external forcing values.

ExtOldMethod (IntEnum)

Enum class containing the valid values for the method attribute in the ExtOldForcing class.

AveragingSpace

  1. Averaging in space

InterpolateExtrapolateTime

  1. Interpolate/Extrapolate time

InterpolateSpace

  1. Interpolate space

InterpolateTime

  1. Interpolate time

InterpolateTimeAndSpace

  1. Interpolate time and space

InterpolateTimeAndSpaceSaveWeights

  1. Interpolate time and space, save weights

PassThrough

  1. Pass through (no interpolation)

ExtOldModel (ParsableFileModel) pydantic-model

The overall external forcings model that contains the contents of one external forcings file (old format).

This model is typically referenced under a FMModel.external_forcing.extforcefile.

dict(self, *args, **kwargs)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Source code in hydrolib/core/dflowfm/extold/models.py 
def dict(self, *args, **kwargs):
    return dict(comment=self.comment, forcing=[dict(f) for f in self.forcing])

ExtOldQuantity (str, Enum)

Enum class containing the valid values for the boundary conditions category of the external forcings.

AdvectionType

Type of advection scheme

AirPressureWindXWindY

Atmospheric pressure and wind components

AirPressureWindXWindYCharnock

Atmospheric pressure and wind components Charnock

AtmosphericPressure

Atmospheric pressure

BedLevel

Bed level

DamLevel

Dam level

DewPointAirTemperatureCloudiness

Dew point air temperature cloudiness

DischargeBnd

Discharge

DischargeSalinityTemperatureSorSin

Discharge, salinity temperature source-sinks

FrictionCoefficient

Friction coefficient

GateLowerEdgeLevel

Gate lower edge level

GeneralStructure

General structure

HorizontalEddyDiffusivityCoefficient

Horizontal eddy diffusivity coefficient

HorizontalEddyViscosityCoefficient

Horizontal eddy viscosity coefficient

HumidityAirTemperatureCloudiness

Combined heat flux terms

HumidityAirTemperatureCloudinessSolarRadiation

Combined heat flux terms

IBotLevType

Type of bed-level handling

InitialSalinity

Initial salinity

InitialSalinityTop

Initial salinity top layer

InitialTemperature

Initial temperature

InitialVerticalSalinityProfile

Initial vertical salinity profile

InitialVerticalTemperatureProfile

Initial vertical temperature profile

InitialWaterLevel

Initial water level

InternalTidesFrictionCoefficient

Internal tides friction coefficient

LongWaveRadiation

Long wave radiation

MovingStationXY

Moving observation point for output (time, x, y)

NeumannBnd

Water level gradient

NormalVelocityBnd

Normal velocity

NudgeSalinityTemperature

Nudging salinity and temperature

OutflowBnd

Outflow

Pump

Pump capacity

QhBnd

Discharge-water level dependency

Rainfall

Precipitation

RainfallRate

Precipitation

RiemannBnd

Riemann invariant

RiemannVelocityBnd

Riemann invariant velocity

SalinityBnd

Salinity

SedimentBnd

Suspended sediment

ShiptXY

shiptxy

SolarRadiation

Solar radiation

TangentialVelocityBnd

Tangentional velocity

TemperatureBnd

Temperature

UXUYAdvectionVelocityBnd

ux-uy advection velocity

VelocityBnd

Velocity

WaterLevelBnd

Water level

WavePeriod

Wave period

WaveSignificantHeight

Wave significant height

WindX

Wind x component

WindXY

Wind vector

WindY

Wind y component

ExtOldTracerQuantity (str, Enum)

Enum class containing the valid values for the boundary conditions category of the external forcings that are specific to tracers.

InitialTracer

Initial tracer

TracerBnd

User-defined tracer

Back to top