Difference between revisions of "ZIE-file"

From BlueM
Jump to: navigation, search
(Neues ZIE-Format (v1.4))
(Added new column "CurValue" to "Aggregate" block (as of v1.7.0, r1785))
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Vorlage:BlueM.Opt Eingabedateien}}
+
{{Template:BlueM.Opt input files}}
 
<div class="info_versionen">
 
<div class="info_versionen">
'''Versionen:'''
+
'''Versions:'''
* '''aktuell''' v1.4 (ab )
+
* '''current''' v1.7 (as of r1727)
* [{{SERVER}}/bluem/wiki/index.php?title=ZIE-Datei&oldid=6096 v1.3] (ab r1436)
+
* [{{SERVER}}/index.php?title=ZIE-file&oldid=7274 v1.6] (as of r1762)
* [{{SERVER}}/bluem/wiki/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
+
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6776 v1.4, v1.5] (as of r1524)
 +
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=6096 v1.3] (as of r1436)
 +
* [{{SERVER}}/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
 
</div>
 
</div>
Diese Datei definiert die Ziele für die Optimierung. Jede Zeile entspricht einer Zielfunktion.
+
<div style="float:left; margin:0 10px 10px 0;">__TOC__</div>
 +
This file defines the objective functions for the optimization.  
  
Die Datei muss den gleichen Namen wie der Simulations-Datensatz haben, aber mit der Endung '''.ZIE''', 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>.ZIE</code>''', and be located in the same directory as the rest of the dataset.<br clear="all"/>
  
 
The file is divided into several blocks, each of which is optional. Each block is identified by its heading:
 
The file is divided into several blocks, each of which is optional. Each block is identified by its heading:
* '''Reihenvergleich''': This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
+
* '''Series''': This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
* '''Wertevergleich''': This block defines objective functions that are based on a comparison of simulation result values with a reference value.
+
* '''Values''': This block defines objective functions that are based on a comparison of simulation result values with a reference value (currently only functional for [[SWMM]] applications, see #414).
* '''Reihenwertevergleich''': This block defines objective functions that are based on a comparison of values that are computed from simulation time series with reference values.
+
* '''ValueFromSeries''': This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.
* '''IHA-Analyse''': Indicators of Hydrologic Alteration
 
 
* '''SKos''': Damages and Costs
 
* '''SKos''': Damages and Costs
* '''Aggregierte Ziele''': Aggregate objective functions
+
* '''Aggregate''': Aggregate objective functions
  
 +
==File format==
 
<bluem>
 
<bluem>
*Optimierungsziele
+
*Objective functions
*=================
+
*===================
 
*
 
*
*Reihenvergleich
+
*Series
*---------------
+
*------
 
*
 
*
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|----------------------------------------|---------|
+
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------------------------|----------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak | Datei | SimGröße  | ZielFkt | EvalZeitraum |        Referenzreihe                  | IstWert |
+
*| Opt | Name          | Group   | D | OpFac | File  | SimResult  | ObjFunc |           Evaluation period        |       Reference series      | CurValue |
*|    |              |        |  |      |      |            |        | Start | Ende | RefGröße | Datei                      |         |
+
*|    |              |        |  |      |      |            |        |       Start     |     End          | RefName  | RefFile        |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|----------|-----------------------------|---------|
+
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
  |  P  | NashSutcliffe |        | - |      |  WEL  | B401      | NashSutt|       |     |         | Zeitreihe.zre               |         |
+
  |  P  | NashSutcliffe |        | - |      |  WEL  | B401      | NashSutt| 30.05.1984 00:00 | 18.06.1984 23:30 |           | seriesfile.zre |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|----------|-----------------------------|---------|
+
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
 
*
 
*
*Wertevergleich
+
*Values
*--------------
+
*------
 
*
 
*
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|----------------|---------|---------|
+
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak | Datei |   SimGröße | ZielFkt | Zielgröße        | OptGröße      |         | IstWert |
+
*| Opt | Name          | Group   | D | OpFac | File  | SimResult | ObjFunc | TargetElement | TargetValue |         | CurValue |
*|    |              |        |  |      |      |           |        | (Block)         | (Spalte)       | RefWert |         |
+
*|    |              |        |  |      |      |           |        | (Block)       | (Column)   | RefValue |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|----------------|---------|---------|
+
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
  |  P  | OutfallLoad  |        | - |      |  RPT  |           |  Diff  | OutfallNode     | AvgFlow       |    0   |         |
+
  |  P  | OutfallLoad  |        | - |      |  RPT  |           |  Diff  | OutfallNode   | AvgFlow     |    0   |         |
  |  S  | Speicher      | Becken  | - |   + |  BLZ  | B401       |        | Speicher         | maxVolume     |         |         |
+
  |  S  | Storage401    | Storage | - |   +   |  BLZ  | B401     |        | Speicher     | maxVolume   |         |         |
  |  S  | Speicher      | Becken  | - |   + |  BLZ  | B701       |        | Speicher         | maxVolume     |         |         |
+
  |  S  | Storage701    | Storage | - |   +   |  BLZ  | B701     |        | Speicher     | maxVolume   |         |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|----------------|---------|---------|
+
*|-----|---------------|---------|---|-------|-------|-----------|---------|-------------- |-------------|----------|----------|
 
*
 
*
*Reihenwertevergleich
+
*ValueFromSeries
*--------------------
+
*---------------
*
 
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|-------------------|---------|
 
*| Opt | Bezeichnung  | Gruppe  | R | OpFak | Datei |  SimGröße | ZielFkt | EvalZeitraum |  Referenzwert    | IstWert |
 
*|    |              |        |  |      |      |            |        | Start | Ende | WertTyp | RefWert |        |
 
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|---------|---------|---------|
 
|  P  | OutfallLoad  |        | - |      |  WEL  | B401_2AB  |  Diff  |      |      |        |        |        |
 
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|---------|---------|---------|
 
*
 
*IHA-Analyse
 
*-----------
 
 
*
 
*
*|-----|---------------|---------|---|-------|-------|------------|-----------|-------------------------------|----------|
+
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|----------------------|----------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak | Datei | SimGröße  | ZielFkt  |         Referenzreihe        | IstWert  |
+
*| Opt | Name          | Group   | D | OpFac | File  | SimResult  | ObjFunc | Evaluation period | Reference value      | CurValue |
*|    |              |        |  |      |      |            |           | RefGröße | Datei              |          |
+
*|    |              |        |  |      |      |            |         | Start  | Ende    | ValueType | RefValue |          |
*|-----|---------------|---------|---|-------|-------|------------|-----------|----------|--------------------|----------|
+
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
  |  P  | IHAGesamt    |        |   |      | WEL   | S09 _1ZU  |          | TOLF_1ZU | ZRE\Olef_orig.wel  |          |
+
  |  P  | OutfallLoad  |        | - |      | WEL  | B401_2AB   |  Diff   |        |        |           |          |          |
|  S | IHAQuantity  |        |  |      | WEL  | S09 _1ZU   | Quantity  | TOLF_1ZU | ZRE\Olef_orig.wel  |          |
+
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
|  S | IHAExtremes  |        |  |      | WEL  | S09 _1ZU   | Extremes  | TOLF_1ZU | ZRE\Olef_orig.wel  |          |
 
|  S  | IHATiming    |        |  |      | WEL  | S09 _1ZU  | Timing    | TOLF_1ZU | ZRE\Olef_orig.wel  |          |
 
|  S  | IHAFrequency  |        |   |      | WEL  | S09 _1ZU  | Frequency | TOLF_1ZU | ZRE\Olef_orig.wel  |          |
 
|  S  | IHARate      |        |  |      | WEL  | S09 _1ZU  | Rate      | TOLF_1ZU | ZRE\Olef_orig.wel  |          |
 
*|-----|---------------|---------|---|-------|-------|------------|-----------|----------|--------------------|----------|
 
 
*
 
*
 
*SKos
 
*SKos
 
*----
 
*----
 
*
 
*
*|-----|---------------|---------|---|-------|
+
*|-----|-------------|---------|---|-------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak |
+
*| Opt | Name        | Group   | D | OpFac |
*|    |               |        |  |      |
+
*|    |             |        |  |      |
*|-----|---------------|---------|---|-------|
+
*|-----|-------------|---------|---|-------|
  |  P  | Baukosten    |        |  |      |
+
  |  P  | ConstrCosts |        |  |      |
*|-----|---------------|---------|---|-------|
+
*|-----|-------------|---------|---|-------|
 
*
 
*
*Aggregierte Ziele
+
*Aggregate
*-----------------
+
*---------
 
*
 
*
*|-----|---------------|---------|---|
+
*|-----|--------------|---------|---|----------|
*| Opt | Bezeichnung   | Gruppe  | R |
+
*| Opt | Name        | Group   | D | CurValue |
*|-----|---------------|---------|---|
+
*|-----|--------------|---------|---|----------|
  |  P  | Beckengesamt  | Becken  |  |
+
  |  P  | TotalStorage | Storage |          |
*|-----|---------------|---------|---|
+
*|-----|--------------|---------|---|----------|
 
</bluem>
 
</bluem>
  
===Spaltenbeschreibung===
+
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.
 +
 
 +
==Description==
 +
===Common parameters===
 +
The blocks "Series", "Values" and "ValuesFromSeries" share a set of parameters.
 
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 
|-  
 
|-  
! width="150" | Parameter !! width="500" | Beschreibung
+
! width="150" | Parameter !! width="500" | Description
 
|-
 
|-
| '''Opt''' || Angabe, ob es sich um ein ''Primärziel'' handelt (<code>P</code>) oder nicht (<code>N</code>). Wenn nicht, handelt es sich um ein ''Sekundärziel'', die zwar immer ausgewertet wird, aber nicht für die Optimierung herangezogen wird.
+
| '''Opt''' || Specifies, whether the objective function is a '''primary objective function''' (<code>P</code>) or a '''secondary objective function''' (<code>S</code>).<br/>Primary objective functions are used to calculate the fitness of invidual solutions.<br/>Secondary objective functions are evaluated, but are not used to determine the fitness of individuals. Secondary objective functions are useful for specifiying objective functions that are part of an aggregated objective function or for specifying values of interest that should be evaluated, but not optimized towards.
 
|-
 
|-
| '''Bezeichnung''' || Bezeichnung des Ziels (beliebig)
+
| '''Name''' || Arbitrary name of the objective function
 
|-
 
|-
| '''Gruppe''' || Group name for aggregated objective functions
+
| '''Group'''<br/>(optional) || Optional group name, only used for calculating aggregated objective functions. Objective functions with the same group name are aggregated to form one aggregated objective function.
 
|-
 
|-
| '''R'''ichtung
+
| '''D'''irection<br/>(optional)
 
|
 
|
*<code>-</code>: Die Zielfunktion soll minimiert werden (Standard)
+
Direction of desired optimization:
*<code>+</code>: Die Zielfunktion soll maximiert werden (hierzu wird der evaluierte Zielwert mit -1 multipliziert, siehe Bug 303)
+
*<code>-</code>: The objective function should be minimized (default)
 +
*<code>+</code>: The objective function should be maximized. This causes the objective function values to be multiplied by <code>-1</code> (#303).
 
|-
 
|-
| '''Op'''erator oder '''Fak'''tor
+
| '''Op'''erator or '''Fac'''tor<br/>(optional)
 
|
 
|
*<code>+</code>: Der Zielwert wird zur Gruppe addiert
+
Optional, only used for aggregated objective functions
*<code>-</code>: Der Zielwert wird von der Gruppe subtrahiert
+
*<code>+</code>: The objective function value is added to the group
*<code>2; 0.5; -10</code>: Ein Faktor, mit dem der Zielwert multipliziert und dann zur Gruppe addiert wird.
+
*<code>-</code>: The objective function value is subtracted from the group
 +
*''number'': The objective function value is multiplied by the given number and then added to the group
 
|-
 
|-
| '''Datei''' || Die Ergebnisdatei, aus der das Simulationsergebnis ausgelesen werden soll [WEL, KWL, ASC, <del>BIL, PRB</del> (Bug 220)]
+
| '''File''' || The simulation result file containing the simulation result from which the objective function should be calculated. Supported values:
 +
* <code>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
 +
* <code>KWL</code> (only for [[BlueM.Sim]])
 +
* <code>KTR.WEL</code> (only for [[TALSIM]])
 +
* <code>ASC</code> (only for [[SMUSI]] and [[SWMM]])
 
|-
 
|-
| '''SimGröße''' || Die Simulationsgröße, auf dessen Basis der Qualitätswert berechnet werden soll
+
| '''SimResult''' || The identifier of the simulation result from which the objective function should be calculated.
 
|-
 
|-
| '''ZielFkt''' || Gibt an welche Zielfunktion verwendet werden soll.
+
| '''ObjFunc''' || Specified which objective function to use. Supported values:
* <code>AbQuad</code>: Abweichung der Fehlerquadrate
+
* <code>AbQuad</code>: Sum of squared errors
* <code>NashSutt</code>: Nash-Sutcliffe Koeffizient{{:Literatur:Nash-Sutcliffe_1970|}}
+
* <code>NashSutt</code>: Nash-Sutcliffe Coefficient{{:Literatur:Nash-Sutcliffe_1970|}}
:abgeänderte Formel mit <code>0 < E < &infin;</code> :
+
:modified formula with <code>0 < E < &infin;</code> :
:<math>E=\frac{\sum_{t=1}^T\left(Q_{gem}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{gem}^t-\overline{Q_{gem}}\right)^2}</math>
+
:<math>E=\frac{\sum_{t=1}^T\left(Q_{obs}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{obs}^t-\overline{Q_{obs}}\right)^2}</math>
* <code>Diff</code>: Differenz
+
* <code>Diff</code>: Difference
* <code>nÜber</code>: Relative Anzahl der Zeitschritte mit Überschreitung des Referenzwerts/der Referenzreihe [%]
+
* <code>nÜber</code>: Relative number of timesteps in which the simulation result is larger than (exceeds) the value of the reference time series [%]
* <code>sÜber</code>: Summe der Überschreitungen des Referenzwerts/der Referenzreihe
+
* <code>sÜber</code>: Sum of the simulation values that are larger than the values of the reference time series
* <code>nUnter</code>: Relative Anzahl der Zeitschritte mit Unterschreitung des Referenzwerts/der Referenzreihe [%]
+
* <code>nUnter</code>: Relative number of timesteps in which the simulation result is smaller than the value of the reference time series [%]
* <code>sUnter</code>: Summe der Unterschreitungen des Referenzwerts/der Referenzreihe
+
* <code>sUnter</code>: Sum of the simulation values that are smaller than the values of the reference time series
* <code>Korr</code>: [http://de.wikipedia.org/wiki/Bestimmtheitsma%C3%9F Bestimmtheitsmaß] (einfache lineare Regression) <code>0 &le; R² &le; 1</code>:
+
* <code>Korr</code>: [https://en.wikipedia.org/wiki/Coefficient_of_determination Coefficient of determination] (simple linear regression) <code>0 &le; R² &le; 1</code>:
 
:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
 
:<math>R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}</math>
* <code>Volf</code>: Volumenfehler [%]
+
* <code>Volf</code>: Volume error [%]
* <code>IHA</code>: [[Zielfunktion IHA | Indicators of Hydrologic Alteration]]
+
|-
 +
| '''CurValue'''<br/>(optional) || An optional value that is displayed in diagrams to serve as an indication of improvement.
 +
|}
 +
 
 +
==="Series"===
 +
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 +
|-
 +
! width="150" | Parameter !! width="500" | Description
 
|-
 
|-
| '''EvalZeitraum'''<br/>(optional) || Bestimmt den Zeitraum, für den die Zielfunktion ausgewertet werden soll.<br/>
+
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
 
Format: <code>dd.mm.yyyy hh:mm</code><br/>
 
Format: <code>dd.mm.yyyy hh:mm</code><br/>
Wenn nicht angegeben, wird der Simulationszeitraum verwendet.
+
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
 
|-
 
|-
| '''WertTyp''' || Gibt an wie der Wert, der mit dem Referenzwert verglichen werden soll, aus dem Simulationsergebnis berechnet werden soll.
+
| '''RefName'''<br/>(nur bei Referenzreihen und .WEL als Referenzdatei) || Specifies the identifier of the time series with which the simulation result should be compared. Only necessary if the time series file specified under '''RefFile''' is in [[WEL-format]].  
* <code>MaxWert</code>: Maximaler Wert des Simulationsergebnisses
 
* <code>MinWert</code>: Minimaler Wert des Simulationsergebnisses
 
* <code>Average</code>: Durchschnittlicher Wert des Simulationsergebnisses
 
* <code>AnfWert</code>: Der erste wert des Simulationsergebnisses
 
* <code>EndWert</code>: Der letzte Wert des Simulationsergebnisses
 
* <code>Summe</code>: Summe des Simulationsergebnisses
 
 
|-
 
|-
| '''RefWert''' || Der zu vergleichende Referenzwert
+
| '''RefFile''' || The filename of the reference time series ([[ZRE-Format|.zre]] or [[WEL-Format|.wel]])<br/><span style="color:red">'''Warning:''' The time step size of the reference series must be identical to that of the simulation result! (see #218)</span>
 +
|}
 +
 
 +
 
 +
==="Values"===
 +
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 +
|-
 +
! width="150" | Parameter !! width="500" | Description
 
|-
 
|-
| '''RefGröße'''<br/>(nur bei Referenzreihen und .WEL als Referenzdatei) || Gibt an welche Spalte der .WEL Referenzdatei zum Vergleich herangezogen werden soll.
+
| '''TargetElement (Block)''' || Specifies in which section (block) the target variable is located.
 +
|-
 +
| '''TargetValue (Column)''' || Specifies the target variable within the block.
 +
|-
 +
| '''RefValue''' || The reference value with which the simulation result should be compared.
 +
|}
 +
 
 +
The parameter TargetElement is dependent on the parameter TargetValue and the simulation tool used, only the following combinations are possible:
 +
 
 +
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 +
|-
 +
! width="100" | Application !! width="200" | TargetElement (Block) !! width="200" | TargetValue (Column)
 +
|-
 +
| '''SWMM''' || NodeFlooding || HoursFlooded
 +
|-
 +
| '''SWMM''' || NodeFlooding || FloodVolume
 +
|-
 +
| '''SWMM''' || StorageVolume || AvgVolume
 +
|-
 +
| '''SWMM''' || StorageVolume || AvgPctFull
 +
|-
 +
| '''SWMM''' || StorageVolume || MaxVolume
 +
|-
 +
| '''SWMM''' || StorageVolume || MaxPctFull
 +
|-
 +
| '''SWMM''' || StorageVolume || MaxOutflow
 +
|-
 +
| '''SWMM''' || OutfallLoad || MaxFlow
 +
|-
 +
| '''SWMM''' || OutfallLoad || FlowVolume
 +
|-
 +
| '''SWMM''' || OutfallLoad || Pollutant_[no]
 +
|-
 +
| '''SWMM''' || Pumping || OnlineTime
 +
|-
 +
| '''SWMM''' || Pumping || TotalEnergy
 +
|-
 +
| '''Smusi''' || EntlVolumen || SumVol
 +
|-
 +
| '''Smusi''' || MaxAbfluss || Qmax
 +
|-
 +
| '''Smusi''' || EntlFracht || CSBspez
 +
|}
 +
 
 +
The TargetValue Pollutant_[no] allows for the evaluation of up to five substances, [no] can take values of 01, 02, 03, 04 or 05, so e.g. specify Pollutant_02 for the second substance.
 +
 
 +
==="ValueFromSeries"===
 +
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 +
|-
 +
! width="150" | Parameter !! width="500" | Description
 +
|-
 +
| '''Evaluation period'''<br/>(optional) || Specifies the simulation time period for which the objective function should be evaluated.<br/>
 +
Format: <code>dd.mm.yyyy hh:mm</code><br/>
 +
If '''Start''' and/or '''End''' are left empty, the start and/or end of the entire simulation time period is used.
 
|-
 
|-
| '''RefDatei''' || Der Dateiname der Referenzreihe ([[ZRE-Format|.zre]] oder [[WEL-Format|.wel]])<br/><span style="color:red">'''Achtung:''' Die Zeitschrittweite der Referenzreihe muss mit dem Zeitschritt der Simulation übereinstimmen! (siehe Bug 218)</span>
+
| '''ValueType''' || Specifies how to calculate the value from the simulation result series. Supported values:
 +
* <code>MaxWert</code>: Maximum value of the simulation result
 +
* <code>MinWert</code>: Minimum value of the simulation result
 +
* <code>Average</code>: Average value of the simulation result
 +
* <code>AnfWert</code>: The first value of the simulation result
 +
* <code>EndWert</code>: The last value of the simulation result
 +
* <code>Summe</code>: Sum of the simulation result
 
|-
 
|-
| '''IstWert'''<br/>(optional) || Ein Wert, der in den Diagrammen als Vergleichswert angezeigt wird.
+
| '''RefValue''' || The reference value with which the computed simulation result should be compared.
 
|}
 
|}
Die Breite der Spalten darf bei Bedarf angepasst werden, nur alle "|"-Zeichen müssen erhalten bleiben!
 
  
Ein "<code>*</code>" am Anfang einer Zeile führt dazu, dass die Zeile ignoriert wird.
 
  
==Literaturangaben==
+
==Literature==
 
<references/>
 
<references/>
  
[[Kategorie:BlueM.Opt Eingabedateien]]
+
[[Category:BlueM.Opt input files|Z]]

Revision as of 02:24, 6 February 2019

EVO.png BlueM.Opt | Downloads | Usage | Development | Bugs | SVN

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


Versions:

This file defines the objective functions for the optimization.

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

The file is divided into several blocks, each of which is optional. Each block is identified by its heading:

  • Series: This block defines objective functions that are based on a comparison of simulation time series with a reference time series.
  • Values: This block defines objective functions that are based on a comparison of simulation result values with a reference value (currently only functional for SWMM applications, see #414).
  • ValueFromSeries: This block defines objective functions that are based on a comparison of values that are computed from simulated time series with reference values.
  • SKos: Damages and Costs
  • Aggregate: Aggregate objective functions

File format

*Objective functions
*===================
*
*Series
*------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------------------------|----------|
*| Opt | Name          | Group   | D | OpFac | File  | SimResult  | ObjFunc |           Evaluation period         |       Reference series      | CurValue |
*|     |               |         |   |       |       |            |         |       Start      |     End          | RefName   | RefFile         |          |
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
 |  P  | NashSutcliffe |         | - |       |  WEL  | B401       | NashSutt| 30.05.1984 00:00 | 18.06.1984 23:30 |           | seriesfile.zre  |          |
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|------------------|-----------|-----------------|----------|
*
*Values
*------
*
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
*| Opt | Name          | Group   | D | OpFac | File  | SimResult | ObjFunc | TargetElement | TargetValue |          | CurValue |
*|     |               |         |   |       |       |           |         | (Block)       | (Column)    | RefValue |          |
*|-----|---------------|---------|---|-------|-------|-----------|---------|---------------|-------------|----------|----------|
 |  P  | OutfallLoad   |         | - |       |  RPT  |           |  Diff   | OutfallNode   | AvgFlow     |     0    |          |
 |  S  | Storage401    | Storage | - |   +   |  BLZ  | B401      |         | Speicher      | maxVolume   |          |          |
 |  S  | Storage701    | Storage | - |   +   |  BLZ  | B701      |         | Speicher      | maxVolume   |          |          |
*|-----|---------------|---------|---|-------|-------|-----------|---------|-------------- |-------------|----------|----------|
*
*ValueFromSeries
*---------------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|----------------------|----------|
*| Opt | Name          | Group   | D | OpFac | File  | SimResult  | ObjFunc | Evaluation period | Reference value      | CurValue |
*|     |               |         |   |       |       |            |         | Start   | Ende    | ValueType | RefValue |          |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
 |  P  | OutfallLoad   |         | - |       |  WEL  | B401_2AB   |  Diff   |         |         |           |          |          |
*|-----|---------------|---------|---|-------|-------|------------|---------|---------|---------|-----------|----------|----------|
*
*SKos
*----
*
*|-----|-------------|---------|---|-------|
*| Opt | Name        | Group   | D | OpFac |
*|     |             |         |   |       |
*|-----|-------------|---------|---|-------|
 |  P  | ConstrCosts |         |   |       |
*|-----|-------------|---------|---|-------|
*
*Aggregate
*---------
*
*|-----|--------------|---------|---|----------|
*| Opt | Name         | Group   | D | CurValue |
*|-----|--------------|---------|---|----------|
 |  P  | TotalStorage | Storage |   |          |
*|-----|--------------|---------|---|----------|

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.

Description

Common parameters

The blocks "Series", "Values" and "ValuesFromSeries" share a set of parameters.

Parameter Description
Opt Specifies, whether the objective function is a primary objective function (P) or a secondary objective function (S).
Primary objective functions are used to calculate the fitness of invidual solutions.
Secondary objective functions are evaluated, but are not used to determine the fitness of individuals. Secondary objective functions are useful for specifiying objective functions that are part of an aggregated objective function or for specifying values of interest that should be evaluated, but not optimized towards.
Name Arbitrary name of the objective function
Group
(optional)
Optional group name, only used for calculating aggregated objective functions. Objective functions with the same group name are aggregated to form one aggregated objective function.
Direction
(optional)

Direction of desired optimization:

  • -: The objective function should be minimized (default)
  • +: The objective function should be maximized. This causes the objective function values to be multiplied by -1 (#303).
Operator or Factor
(optional)

Optional, only used for aggregated objective functions

  • +: The objective function value is added to the group
  • -: The objective function value is subtracted from the group
  • number: The objective function value is multiplied by the given number and then added to the group
File The simulation result file containing the simulation result from which the objective function should be calculated. Supported values:
SimResult The identifier of the simulation result from which the objective function should be calculated.
ObjFunc Specified which objective function to use. Supported values:
  • AbQuad: Sum of squared errors
  • NashSutt: Nash-Sutcliffe Coefficient[1]
modified formula with 0 < E < ∞ :
[math]E=\frac{\sum_{t=1}^T\left(Q_{obs}^t-Q_{sim}^t\right)^2}{\sum_{t=1}^T\left(Q_{obs}^t-\overline{Q_{obs}}\right)^2}[/math]
  • Diff: Difference
  • nÜber: Relative number of timesteps in which the simulation result is larger than (exceeds) the value of the reference time series [%]
  • sÜber: Sum of the simulation values that are larger than the values of the reference time series
  • nUnter: Relative number of timesteps in which the simulation result is smaller than the value of the reference time series [%]
  • sUnter: Sum of the simulation values that are smaller than the values of the reference time series
  • Korr: Coefficient of determination (simple linear regression) 0 ≤ R² ≤ 1:
[math]R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y}[/math]
  • Volf: Volume error [%]
CurValue
(optional)
An optional value that is displayed in diagrams to serve as an indication of improvement.

"Series"

Parameter Description
Evaluation period
(optional)
Specifies the simulation time period for which the objective function should be evaluated.

Format: dd.mm.yyyy hh:mm
If Start and/or End are left empty, the start and/or end of the entire simulation time period is used.

RefName
(nur bei Referenzreihen und .WEL als Referenzdatei)
Specifies the identifier of the time series with which the simulation result should be compared. Only necessary if the time series file specified under RefFile is in WEL-format.
RefFile The filename of the reference time series (.zre or .wel)
Warning: The time step size of the reference series must be identical to that of the simulation result! (see #218)


"Values"

Parameter Description
TargetElement (Block) Specifies in which section (block) the target variable is located.
TargetValue (Column) Specifies the target variable within the block.
RefValue The reference value with which the simulation result should be compared.

The parameter TargetElement is dependent on the parameter TargetValue and the simulation tool used, only the following combinations are possible:

Application TargetElement (Block) TargetValue (Column)
SWMM NodeFlooding HoursFlooded
SWMM NodeFlooding FloodVolume
SWMM StorageVolume AvgVolume
SWMM StorageVolume AvgPctFull
SWMM StorageVolume MaxVolume
SWMM StorageVolume MaxPctFull
SWMM StorageVolume MaxOutflow
SWMM OutfallLoad MaxFlow
SWMM OutfallLoad FlowVolume
SWMM OutfallLoad Pollutant_[no]
SWMM Pumping OnlineTime
SWMM Pumping TotalEnergy
Smusi EntlVolumen SumVol
Smusi MaxAbfluss Qmax
Smusi EntlFracht CSBspez

The TargetValue Pollutant_[no] allows for the evaluation of up to five substances, [no] can take values of 01, 02, 03, 04 or 05, so e.g. specify Pollutant_02 for the second substance.

"ValueFromSeries"

Parameter Description
Evaluation period
(optional)
Specifies the simulation time period for which the objective function should be evaluated.

Format: dd.mm.yyyy hh:mm
If Start and/or End are left empty, the start and/or end of the entire simulation time period is used.

ValueType Specifies how to calculate the value from the simulation result series. Supported values:
  • MaxWert: Maximum value of the simulation result
  • MinWert: Minimum value of the simulation result
  • Average: Average value of the simulation result
  • AnfWert: The first value of the simulation result
  • EndWert: The last value of the simulation result
  • Summe: Sum of the simulation result
RefValue The reference value with which the computed simulation result should be compared.


Literature

  1. Nash, J. E. and Sutcliffe, J. V. (1970): River flow forecasting through conceptual models part I — A discussion of principles, Journal of Hydrology, 10 (3), 282–290, DOI:10.1016/0022-1694(70)90255-6.