MOD-file

From BlueM
Jump to navigation Jump to search

EVO.png BlueM.Opt | Download | Usage | Development

BlueM.Opt input files: MOD · OPT · OBF · CON


This file defines the model parameters. They are derived from the optimization parameters and written to the input files of the simulation model (the dataset). Each line corresponds to one model parameter.

The file must have the same filename as the rest of the dataset's files but have the file extension .MOD, and be located in the same directory as the rest of the dataset.

The MOD file behaves slightly differently depending on whether the simulation model dataset is text-based (e.g. with BlueM.Sim, Talsim ASCII dataset, SWMM) or is a database (Talsim5).

Text-based datasets

For text-based datasets, the MOD file defines in which file, line number and in which columns a model parameter is located.

Example for auto-calibration of a rainfall-runoff model with runoff-coefficient and retention constant for two catchments:

*Model parameters
*================
*
*|--------------|---------|-------|------|--------|------|------|-----|--------|
*| OptParameter | Name    | Unit  | File | Element| Line | from | to  | Factor |
*|--------------|---------|-------|------|--------|------|------|-----|--------|
 | PSI          | A01_psi |   -   |  EZG |  S201  |   10 | 110  | 114 |   1    |
 | PSI          | A02_psi |   -   |  EZG |  S201  |   11 | 110  | 114 |   1    |
 | RetKonst     | A01_K1  |   -   |  EZG |  S201  |   10 | 143  | 148 |   10   |
 | RetKonst     | A02_K1  |   -   |  EZG |  S201  |   11 | 143  | 148 |   10   |
*|--------------|---------|-------|------|--------|------|------|-----|--------|

Description

Parameter Description
OptParameter Name of the optimization parameter from which this model parameter is derived.
Name Arbitrary name of the model parameter
Unit
(optional)
Unit of the parameter value
File File extension of the model input file in which the model parameter is located. (E.g. for BlueM.Sim: EZG, TRS, TAL, BOF, BOA, BOD, etc.)
Element
(optional)
Name of the element associated with the model parameter.
Line Line number at which the parameter is located within the model input file.
from & to Column numbers between which the model parameter is defined within the model input file.
Factor Factor with which the optimization parameter value should be multiplied to obtain the model parameter value.

The width of the columns can be adjusted if necessary, but the column separators (|) must be preserved!

An asterisk (*) at the beginning of the line causes the line to be ignored.

Databases

When working with a simulation dataset in dabatase format (e.g. with Talsim5), the MOD file defines in which table, field and row a model parameter is defined.

Example for auto-calibration of a rainfall-runoff model with calibration parameters defined as model parameters:

*Model parameters
*================
*
*|--------------|---------------|-------|-------------|--------------------------------------|-----|------|-----|--------|
*| OptParameter | Name          | Unit  | Table       | Field                                | Id  | from | to  | Factor |
*|--------------|---------------|-------|-------------|--------------------------------------|-----|------|-----|--------|
 | RetKonFakUrb | RetKonFakUrb  |       | Calibration | RetentionConstantFactorUrban         |  50 |      |     |   1    |
 | RetKonFakNat | RetKonFakNat  |       | Calibration | RetentionConstantFactorNatural       |  50 |      |     |   1    |
 | RetKonFakInt | RetKonFakInt  |       | Calibration | RetentionConstantFactorInterflow     |  50 |      |     |   1    |
 | RetKonFakInt2| RetKonFakInt2 |       | Calibration | RetentionConstantFactorDeepInterflow |  50 |      |     |   1    |
 | RetKonFakBas | RetKonFakBas  |       | Calibration | RetentionConstantFactorBaseflow      |  50 |      |     |   1    |
 | RetKonFakBas2| RetKonFakBas2 |       | Calibration | RetentionConstantFactorDeepBaseflow  |  50 |      |     |   1    |
 | GWShare      | GWShare       |       | Calibration | GroundwaterShare                     |  50 |      |     |   1    |
 | MaxInf       | MaxInf        |       | Calibration | MaxInfiltration                      |  50 |      |     |   1    |
 | Schicht1kfExx| Schicht1kfExx |       | Calibration | Layer1kfExfiltrationFactor           |  50 |      |     |   1    |
 | Schicht2kfExx| Schicht2kfExx |       | Calibration | Layer2kfExfiltrationFactor           |  50 |      |     |   1    |
 | Schicht3kfExx| Schicht3kfExx |       | Calibration | Layer3kfExfiltrationFactor           |  50 |      |     |   1    |
 | Schicht1kfInt| Schicht1kfInt |       | Calibration | Layer1kfInterflowFactor              |  50 |      |     |   1    |
 | Schicht2kfInt| Schicht2kfInt |       | Calibration | Layer2kfInterflowFactor              |  50 |      |     |   1    |
 | WP           | WP            |       | Calibration | WiltingPointFactor                   |  50 |      |     |   1    |
 | NFK          | NFK           |       | Calibration | AvailableWaterCapacityFactor         |  50 |      |     |   1    |
 | LK           | LK            |       | Calibration | SoilAirCapacityFactor                |  50 |      |     |   1    |
 | T_GRZ_SCHNEE | T_GRZ_SCHNEE  |       | Calibration | TemperatureThresholdSnowfall         |  50 |      |     |   1    |
 | T_GRZ_ABBAU  | T_GRZ_ABBAU   |       | Calibration | TemperatureThresholdSnowmelt         |  50 |      |     |   1    |
*|--------------|---------------|-------|-------------|--------------------------------------|-----|------|-----|--------|

Description

Parameter Description
OptParameter Name of the optimization parameter from which this model parameter is derived.
Name Arbitrary name of the model parameter
Unit
(optional)
Unit of the parameter value
Table Name of the table in the database where the model parameter is located
Field Name of the field of the table in which the model parameter is defined
Id Id of the table row containing the model parameter
from & to
(unused)
Not used
Factor Factor with which the optimization parameter value should be multiplied to obtain the model parameter value.

The width of the columns can be adjusted if necessary, but the column separators (|) must be preserved!

An asterisk (*) at the beginning of the line causes the line to be ignored.

Notes

  • Only database tables that have a field named `Id` are supported
  • Support for Talsim5 databases was added in BlueM.Opt v2.6.0