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 'new' format (ExtForceFileNew
in the MDU file).
Model¶
Boundary
¶
Bases: INIBasedModel
A [Boundary]
block for use inside an external forcings file,
i.e., a ExtModel.
All lowercased attributes match with the boundary input as described in UM Sec.C.5.2.1.
Source code in hydrolib/core/dflowfm/ext/models.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
|
forcing
property
¶
Retrieves the corresponding forcing data for this boundary.
Returns:
Name | Type | Description |
---|---|---|
ForcingBase |
Union[ForcingBase, None]
|
The corresponding forcing data. None when this boundary does not have a forcing file or when the data cannot be found. |
check_nodeid_or_locationfile_present(values)
classmethod
¶
Verifies that either nodeid or locationfile properties have been set.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
values
|
Dict
|
Dictionary with values already validated. |
required |
Raises:
Type | Description |
---|---|
ValueError
|
When none of the values are present. |
Returns:
Name | Type | Description |
---|---|---|
Dict |
Validated dictionary of values for Boundary. |
Source code in hydrolib/core/dflowfm/ext/models.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
|
BoundaryError
¶
Bases: Exception
BoundaryError.
Source code in hydrolib/core/dflowfm/ext/models.py
546 547 548 549 550 551 |
|
__init__(error_message)
¶
BoundaryError constructor.
Source code in hydrolib/core/dflowfm/ext/models.py
549 550 551 |
|
ExtGeneral
¶
Bases: INIGeneral
The external forcing file's [General]
section with file meta-data.
Source code in hydrolib/core/dflowfm/ext/models.py
481 482 483 484 485 486 |
|
ExtModel
¶
Bases: INIModel
The overall external forcings model that contains the contents of one external forcings file (new format).
This model is typically referenced under a FMModel.external_forcing.extforcefilenew
.
Attributes:
Name | Type | Description |
---|---|---|
general |
ExtGeneral
|
|
boundary |
List[Boundary]
|
List of |
lateral |
List[Lateral]
|
List of |
sourcesink |
List[SourceSink]
|
List of |
meteo |
List[Meteo]
|
List of |
Source code in hydrolib/core/dflowfm/ext/models.py
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
|
InitialFieldError
¶
Bases: Exception
InitialFieldError.
Source code in hydrolib/core/dflowfm/ext/models.py
530 531 532 533 534 535 |
|
__init__(error_message)
¶
InitialFieldError constructor.
Source code in hydrolib/core/dflowfm/ext/models.py
533 534 535 |
|
Lateral
¶
Bases: INIBasedModel
A [Lateral]
block for use inside an external forcings file,
i.e., a ExtModel.
All lowercased attributes match with the lateral input as described in UM Sec.C.5.2.2.
Source code in hydrolib/core/dflowfm/ext/models.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
|
validate_location_type(v)
classmethod
¶
Method to validate whether the specified location type is correct.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
v
|
str
|
Given value for the locationtype field. |
required |
Raises:
Type | Description |
---|---|
ValueError
|
When the value given for locationtype is unknown. |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Validated locationtype string. |
Source code in hydrolib/core/dflowfm/ext/models.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
|
validate_that_location_specification_is_correct(values)
¶
Validates that the correct location specification is given.
Source code in hydrolib/core/dflowfm/ext/models.py
168 169 170 171 172 173 |
|
Meteo
¶
Bases: INIBasedModel
A [Meteo]
block for use inside an external forcings file,
i.e., a ExtModel.
All lowercased attributes match with the meteo input as described in UM Sec.C.5.2.3.
Source code in hydrolib/core/dflowfm/ext/models.py
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
|
choose_file_model(values)
¶
Root-level validator to the right class for the filename parameter based on the filetype.
The validator chooses the right class for the filename parameter based on the FileType_FileModel_mapping dictionary.
FILETYPE_FILEMODEL_MAPPING = { "bcascii": ForcingModel, "uniform": TimModel, "unimagdir": TimModel, "arcinfo": DiskOnlyFileModel, "spiderweb": DiskOnlyFileModel, "curvigrid": DiskOnlyFileModel, "netcdf": DiskOnlyFileModel, "polygon": PolyFile, }
Source code in hydrolib/core/dflowfm/ext/models.py
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
|
MeteoError
¶
Bases: Exception
MeteoError.
Source code in hydrolib/core/dflowfm/ext/models.py
538 539 540 541 542 543 |
|
__init__(error_message)
¶
MeteoError constructor.
Source code in hydrolib/core/dflowfm/ext/models.py
541 542 543 |
|
MeteoForcingFileType
¶
Bases: StrEnum
Enum class containing the valid values for the forcingFileType attribute in Meteo class.
Source code in hydrolib/core/dflowfm/ext/models.py
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
|
arcinfo = 'arcInfo'
class-attribute
instance-attribute
¶
str: Space- and time-varying wind and pressure on an equidistant grid in <*.amu/v/p> files.
bcascii = 'bcAscii'
class-attribute
instance-attribute
¶
str: Space-uniform time series in <*.bc> file.
curvigrid = 'curviGrid'
class-attribute
instance-attribute
¶
str: Space- and time-varying wind and pressure on a curvilinear grid in <.grd+.amu/v/p> files.
netcdf = 'netcdf'
class-attribute
instance-attribute
¶
str: NetCDF, either with gridded data, or multiple station time series.
polygon = 'polygon'
class-attribute
instance-attribute
¶
str: Polygon-based time series in <*.pol> file.
spiderweb = 'spiderweb'
class-attribute
instance-attribute
¶
str: Space- and time-varying cyclone wind and pressure in <*.spw> files.
uniform = 'uniform'
class-attribute
instance-attribute
¶
str: Space-uniform time series in <*.tim> file.
unimagdir = 'uniMagDir'
class-attribute
instance-attribute
¶
str: Space-uniform wind magnitude+direction in <*.tim> file.
MeteoInterpolationMethod
¶
Bases: StrEnum
Enum class containing the valid values for the interpolationMethod attribute in Meteo class.
Source code in hydrolib/core/dflowfm/ext/models.py
335 336 337 338 339 340 341 342 343 344 345 346 |
|
ParameterFieldError
¶
Bases: Exception
ParameterFieldError.
Source code in hydrolib/core/dflowfm/ext/models.py
554 555 556 557 558 559 |
|
__init__(error_message)
¶
ParameterFieldError constructor.
Source code in hydrolib/core/dflowfm/ext/models.py
557 558 559 |
|
SourceSink
¶
Bases: INIBasedModel
A [SourceSink]
block for use inside an external forcings file,
i.e., a ExtModel.
All lowercased attributes match with the source-sink input as described in UM Sec.C.5.2.4.
Source code in hydrolib/core/dflowfm/ext/models.py
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
|
Config
¶
Config class to tell Pydantic to accept fields not explicitly declared in the model.
Source code in hydrolib/core/dflowfm/ext/models.py
245 246 247 248 249 250 251 |
|
validate_location_specification(values)
¶
Ensures that either locationfile
or a valid set of coordinates is provided.
This validation enforces that at least one of the following conditions is met:
1. locationfile
is provided.
2. The combination of numcoordinates
, xcoordinates
, and ycoordinates
is valid:
- xcoordinates
and ycoordinates
must be lists of equal length.
- The length of xcoordinates
and ycoordinates
must match numcoordinates
.
Raises:
ValueError: If neither locationfile
nor a valid coordinate set is provided.
Returns: Dict: The validated input values.
Source code in hydrolib/core/dflowfm/ext/models.py
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
|
SourceSinkError
¶
Bases: Exception
SourceSinkError.
Source code in hydrolib/core/dflowfm/ext/models.py
522 523 524 525 526 527 |
|
__init__(error_message)
¶
SourceSinkError constructor.
Source code in hydrolib/core/dflowfm/ext/models.py
525 526 527 |
|