MOD-file: Difference between revisions

From BlueM
Jump to navigation Jump to search
← Older edit

Froehlich (talk | contribs)

4 user groups
3,431 edits
m →Spaltenbeschreibung: Formatierung
m replace obsolete <bluem> tag
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Vorlage:EVO Eingabedateien}}
{{Template:BlueM.Opt input files}}
Diese Datei definiert die zu optimierenden Modellparameter. Jede Zeile entspricht einem Modellparameter. Die Modellparameter sind durch die Spalte "OptParameter" den [[OPT-Datei|Optimierungsparametern]] zugeordnet.
This file defines the model parameters. They are derived from the [[OPT-file|optimization parameters]] and written to the input files of the simulation model (the dataset). Each line corresponds to one model parameter.  


Die Datei muss den gleichen Namen wie der Simulations-Datensatz haben, aber mit der Endung '''.MOD''', und muss sich im Simulations-Arbeitsverzeichnis befinden.  
The file must have the same filename as the rest of the dataset's files but have the file extension '''<code>.MOD</code>''', and be located in the same directory as the rest of the dataset.  


''Beispiel mit Abflussbeiwert und Retentionskonstante von zwei Einzugsgebieten'':
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).
<pre>
 
*ModellParameter
==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'':
<source lang="bluem">
*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  |
*|--------------|---------|-------|------|--------|------|------|-----|--------|
</source>
 
===Description===
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="100" | Parameter !! width="400" | Description
|-
| '''OptParameter''' || Name of the [[OPT-Datei|optimization parameter]] from which this model parameter is derived.
|-
| '''Name''' || Arbitrary name of the model parameter
|-
| '''Unit'''<br/>(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]]: [[BlueM.Sim Eingabedateien|EZG, TRS, TAL, BOF, BOA, BOD, etc.]])
|-
| '''Element'''<br/>(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 (<code>|</code>) must be preserved!
 
An asterisk (<code>*</code>) 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'':
<source lang="bluem">
*Model parameters
*================
*
*
*|--------------|--------------|-------|-------|--------|-------|-----|-----|--------|
*|--------------|---------------|-------|-------------|--------------------------------------|-----|------|-----|--------|
*| OptParameter | Bezeichnung | Einh. | Datei |Elem. /o| Zeile | von | bis | Faktor |
*| OptParameter | Name          | Unit | Table      | Field                                | Id  | from | to  | Factor |
*|-<---------->-|-<---------->-|-<--->-|-<--->-|-<---->-|-<--->-|-<->-|-<->-|-<---->-|
*|--------------|---------------|-------|-------------|--------------------------------------|-----|------|-----|--------|
  | PSI          | A01_psi     |  -   |  EZG |  S201 |  10 | 110 | 114 |  1    |
  | RetKonFakUrb | RetKonFakUrb  |      | Calibration | RetentionConstantFactorUrban        |  50 |      |    |  1    |
  | PSI          | A02_psi     |  -   |  EZG |  S201 |  11 | 110 | 114 |  1    |
| RetKonFakNat | RetKonFakNat  |      | Calibration | RetentionConstantFactorNatural      |  50 |      |    |   1    |
  | RetKonst     | A01_K1       |  -  |  EZG |  S201 |  10 | 143 | 148 |  10  |
| RetKonFakInt | RetKonFakInt |      | Calibration | RetentionConstantFactorInterflow    | 50 |      |    |  1    |
  | RetKonst    | A02_K1       |  -  |  EZG |  S201 |  11 | 143 | 148 |  10  |
  | RetKonFakInt2| RetKonFakInt2 |      | Calibration | RetentionConstantFactorDeepInterflow | 50 |      |    |  1    |
*|--------------|--------------|-------|-------|--------|-------|-----|-----|--------|
  | RetKonFakBas | RetKonFakBas  |      | Calibration | RetentionConstantFactorBaseflow      |  50 |      |    |  1    |
</pre>
  | 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    |
*|--------------|---------------|-------|-------------|--------------------------------------|-----|------|-----|--------|
</source>


===Spaltenbeschreibung===
===Description===
:{| cellpadding="5" cellspacing="0" border="0" class="standard"
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
|-
! width="100" | Parameter !! width="400" | Description
|-
| '''OptParameter''' || Name of the [[OPT-Datei|optimization parameter]] from which this model parameter is derived.
|-
| '''Name''' || Arbitrary name of the model parameter
|-
|-
! width="100" | Parameter !! width="400" | Beschreibung
| '''Unit'''<br/>(optional) || Unit of the parameter value
|-
|-
| '''OptParameter''' || Bezeichnung des [[OPT-Datei|Optimierungsparameters]] aus welchem dieser Modellparameter berechnet wird
| '''Table''' || Name of the table in the database where the model parameter is located
|- class="odd"
| '''Bezeichnung''' || Bezeichnung des Parameters (beliebig)
|-
|-
| '''Einh.''' || Einheit des Parameterwertes
| '''Field''' || Name of the field of the table in which the model parameter is defined
|- class="odd"
|-  
| '''Datei''' || Endung der Eingabedatei, in der sich der Modellparameter befindet (z.B. bei BlueM: [[BlueM Eingabedateien|EZG, TRS, TAL, BOF, BOA, BOD, etc]])
| '''Id''' || Id of the table row containing the model parameter
|-
|-
| '''Elem. /o'''<br/>''(optional)'' || Bezeichnung des Elements für das dieser Modellparameter zuständig ist
| '''from''' & '''to'''<br/>(unused) || ''Not used''  
|- class="odd"
| '''Zeile''' || Zeile, in der sich der Parameter befindet (gezählt vom Dateianfang der Eingabedatei)
|-
|-
| '''von''' & '''bis''' || Spaltennummern, innerhalb derer der Parameter in der Eingabedatei definiert ist
| '''Factor''' || Factor with which the optimization parameter value should be multiplied to obtain the model parameter value.
|- class="odd"
| '''Faktor''' || ModellParameter = OptimierungsParameter &times; Faktor
|}
|}
Die Breite der Spalten darf bei Bedarf angepasst werden, nur alle "|"-Zeichen müssen erhalten bleiben!
The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!
 
An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.


Ein "<code>*</code>" am Anfang einer Zeile führt dazu, dass die Zeile ignoriert wird.
===Notes===
* Only database tables that have a field named `Id` are supported
* Support for Talsim5 databases was added in BlueM.Opt v2.6.0


[[Kategorie:EVO Eingabedateien]]
[[Category:BlueM.Opt input files|M]]

Latest revision as of 10:04, 12 September 2026

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
Retrieved from "https://wiki.bluemodel.org/index.php?title=MOD-file&oldid=7962"