OBF-file: Difference between revisions

From BlueM
Jump to navigation Jump to search
mNo edit summary
(Erläuterung: WertTyp nach ValueFromSeries verschoben, IstWert nach common)
Line 6: Line 6:
* [{{SERVER}}/bluem/wiki/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
* [{{SERVER}}/bluem/wiki/index.php?title=ZIE-Datei&oldid=5843 v1.2.x]
</div>
</div>
<div style="float:left; margin:0 10px 10px 0;">__TOC__</div>
Diese Datei definiert die Ziele für die Optimierung. Jede Zeile entspricht einer Zielfunktion.
Diese Datei definiert die Ziele für die Optimierung. Jede Zeile entspricht einer Zielfunktion.


Die Datei muss den gleichen Namen wie der Simulations-Datensatz haben, aber mit der Endung '''.ZIE''', und muss sich im Simulations-Arbeitsverzeichnis befinden.  
Die Datei muss den gleichen Namen wie der Simulations-Datensatz haben, aber mit der Endung '''.ZIE''', und muss sich im Simulations-Arbeitsverzeichnis befinden. <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:
Line 133: Line 134:
:<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>: Volumenfehler [%]
|-
| '''IstWert'''<br/>(optional) || Ein Wert, der in den Diagrammen als Vergleichswert angezeigt wird.
|}
|}


Line 146: Line 149:
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.
Wenn nicht angegeben, wird der Simulationszeitraum verwendet.
|-
| '''WertTyp''' || Gibt an wie der Wert, der mit dem Referenzwert verglichen werden soll, aus dem Simulationsergebnis berechnet werden soll.
* <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
|-
|-
| '''RefGröße'''<br/>(nur bei Referenzreihen und .WEL als Referenzdatei) || Gibt an welche Spalte der .WEL Referenzdatei zum Vergleich herangezogen werden soll.
| '''RefGröße'''<br/>(nur bei Referenzreihen und .WEL als Referenzdatei) || Gibt an welche Spalte der .WEL Referenzdatei zum Vergleich herangezogen werden soll.
|-
|-
| '''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>
| '''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>
|-
| '''IstWert'''<br/>(optional) || Ein Wert, der in den Diagrammen als Vergleichswert angezeigt wird.
|}
|}




===Description of block "Values"===
===Description of block "Values"===


:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
Line 175: Line 167:
|-
|-
| '''RefWert''' || Der zu vergleichende Referenzwert
| '''RefWert''' || Der zu vergleichende Referenzwert
|-
| '''IstWert'''<br/>(optional) || Ein Wert, der in den Diagrammen als Vergleichswert angezeigt wird.
|}
|}




Bei jeder Anwendung ist der Parameter OptGröße an die jeweilige Zielgröße gebunden, es gibt also nur bestimmte Kombinnationen.
Bei jeder Anwendung ist der Parameter OptGröße an die jeweilige Zielgröße gebunden, es gibt also nur bestimmte Kombinationen.




Line 223: Line 213:
Wenn nicht angegeben, wird der Simulationszeitraum verwendet.
Wenn nicht angegeben, wird der Simulationszeitraum verwendet.
|-
|-
| '''WertTyp''' || NN
| '''WertTyp''' || Gibt an wie der Wert, der mit dem Referenzwert verglichen werden soll, aus dem Simulationsergebnis berechnet werden soll.
* <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''' || NN
| '''RefWert''' || Der zu vergleichende Referenzwert
|-
| '''IstWert'''<br/>(optional) || Ein Wert, der in den Diagrammen als Vergleichswert angezeigt wird.
|}
|}


Line 244: Line 238:
|-
|-
| '''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>
| '''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>
|-
| '''IstWert'''<br/>(optional) || Ein Wert, der in den Diagrammen als Vergleichswert angezeigt wird.
|}
|}


Revision as of 03:52, 23 July 2009

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

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

Versionen:

Diese Datei definiert die Ziele für die Optimierung. Jede Zeile entspricht einer Zielfunktion.

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 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 (so far only functional for SWMM applications).
  • ValueFromSeries: This block defines objective functions that are based on a comparison of values that are computed from simulation time series with reference values.
  • IHA-Analysis: Indicators of Hydrologic Alteration
  • SKos: Damages and Costs
  • Aggregate: Aggregate objective functions
*Objective functions
*===================
*
*Series
*------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|----------------------------------------|---------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak | Datei | SimGröße   | ZielFkt | EvalZeitraum |         Referenzreihe                  | IstWert |
*|     |               |         |   |       |       |            |         | Start | Ende | RefGröße | Datei                       |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|----------|-----------------------------|---------|
 |  P  | NashSutcliffe |         | - |       |  WEL  | B401       | NashSutt|       |      |          | Zeitreihe.zre               |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|----------|-----------------------------|---------|
*
*Values
*------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|----------------|---------|---------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak | Datei |   SimGröße | ZielFkt | Zielgröße        | OptGröße       |         | IstWert |
*|     |               |         |   |       |       |            |         | (Block)          | (Spalte)       | RefWert |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|----------------|---------|---------|
 |  P  | OutfallLoad   |         | - |       |  RPT  |            |  Diff   | OutfallNode      | AvgFlow        |     0   |         |
 |  S  | Speicher      | Becken  | - |    +  |  BLZ  | B401       |         | Speicher         | maxVolume      |         |         |
 |  S  | Speicher      | Becken  | - |    +  |  BLZ  | B701       |         | Speicher         | maxVolume      |         |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|------------------|----------------|---------|---------|
*
*ValueFromSeries
*---------------
*
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|-------------------|---------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak | Datei |   SimGröße | ZielFkt | EvalZeitraum |   Referenzwert    | IstWert |
*|     |               |         |   |       |       |            |         | Start | Ende | WertTyp | RefWert |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|---------|---------|---------|
 |  P  | OutfallLoad   |         | - |       |  WEL  | B401_2AB   |  Diff   |       |      |         |         |         |
*|-----|---------------|---------|---|-------|-------|------------|---------|-------|------|---------|---------|---------|
*
*IHA-Analysis
*------------
*
*|-----|---------------|---------|---|-------|-------|------------|-----------|-------------------------------|----------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak | Datei | SimGröße   | ZielFkt   |         Referenzreihe         | IstWert  |
*|     |               |         |   |       |       |            |           | RefGröße | Datei              |          |
*|-----|---------------|---------|---|-------|-------|------------|-----------|----------|--------------------|----------|
 |  P  | IHAGesamt     |         |   |       | WEL   | S09 _1ZU   |           | TOLF_1ZU | ZRE\Olef_orig.wel  |          |
 |  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
*----
*
*|-----|---------------|---------|---|-------|
*| Opt | Bezeichnung   | Gruppe  | R | OpFak |
*|     |               |         |   |       |
*|-----|---------------|---------|---|-------|
 |  P  | Baukosten     |         |   |       |
*|-----|---------------|---------|---|-------|
*
*Aggregate
*---------
*
*|-----|---------------|---------|---|
*| Opt | Bezeichnung   | Gruppe  | R |
*|-----|---------------|---------|---|
 |  P  | Beckengesamt  | Becken  |   |
*|-----|---------------|---------|---|

Die Breite der Spalten darf bei Bedarf angepasst werden, nur alle "|"-Zeichen müssen erhalten bleiben!

Ein "*" am Anfang einer Zeile führt dazu, dass die Zeile ignoriert wird.

Spaltenbeschreibung (all blocks)

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

Parameter Beschreibung
Opt Angabe, ob es sich um ein Primärziel handelt (P) oder nicht (N). Wenn nicht, handelt es sich um ein Sekundärziel, die zwar immer ausgewertet wird, aber nicht für die Optimierung herangezogen wird.
Bezeichnung Bezeichnung des Ziels (beliebig)
Gruppe Group name for aggregated objective functions
Richtung
  • -: Die Zielfunktion soll minimiert werden (Standard)
  • +: Die Zielfunktion soll maximiert werden (hierzu wird der evaluierte Zielwert mit -1 multipliziert, siehe Bug 303)
Operator oder Faktor
  • +: Der Zielwert wird zur Gruppe addiert
  • -: Der Zielwert wird von der Gruppe subtrahiert
  • 2; 0.5; -10: Ein Faktor, mit dem der Zielwert multipliziert und dann zur Gruppe addiert wird.
Datei Die Ergebnisdatei, aus der das Simulationsergebnis ausgelesen werden soll [WEL, KWL, ASC, BIL, PRB (Bug 220)]
SimGröße Die Simulationsgröße, auf dessen Basis der Qualitätswert berechnet werden soll
ZielFkt Gibt an welche Zielfunktion verwendet werden soll.
  • AbQuad: Abweichung der Fehlerquadrate
  • NashSutt: Nash-Sutcliffe Koeffizient[1]
abgeänderte Formel mit 0 < E < ∞ :
[math]\displaystyle{ 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]
  • Diff: Differenz
  • nÜber: Relative Anzahl der Zeitschritte mit Überschreitung des Referenzwerts/der Referenzreihe [%]
  • sÜber: Summe der Überschreitungen des Referenzwerts/der Referenzreihe
  • nUnter: Relative Anzahl der Zeitschritte mit Unterschreitung des Referenzwerts/der Referenzreihe [%]
  • sUnter: Summe der Unterschreitungen des Referenzwerts/der Referenzreihe
  • Korr: Bestimmtheitsmaß (einfache lineare Regression) 0 ≤ R² ≤ 1:
[math]\displaystyle{ R^2 = \frac{s^2_{xy}}{s^2_x \cdot s^2_y} }[/math]
  • Volf: Volumenfehler [%]
IstWert
(optional)		 Ein Wert, der in den Diagrammen als Vergleichswert angezeigt wird.


Description of block "Series"

Parameter Beschreibung
EvalZeitraum
(optional)		 Bestimmt den Zeitraum, für den die Zielfunktion ausgewertet werden soll.

Format: dd.mm.yyyy hh:mm
Wenn nicht angegeben, wird der Simulationszeitraum verwendet.

RefGröße
(nur bei Referenzreihen und .WEL als Referenzdatei)		 Gibt an welche Spalte der .WEL Referenzdatei zum Vergleich herangezogen werden soll.
RefDatei Der Dateiname der Referenzreihe (.zre oder .wel)
Achtung: Die Zeitschrittweite der Referenzreihe muss mit dem Zeitschritt der Simulation übereinstimmen! (siehe Bug 218)


Description of block "Values"

Parameter Beschreibung
Zielgröße (Block) Angabe, in welchem Abschnitt (Block) sich die Zielvariable befindet.
OptGröße (Spalte) Angabe der Zielvariablen im Block.
RefWert Der zu vergleichende Referenzwert


Bei jeder Anwendung ist der Parameter OptGröße an die jeweilige Zielgröße gebunden, es gibt also nur bestimmte Kombinationen.


Anwendung Zielgröße (Block) OptGröße (Spalte)
SWMM NodeFlooding HoursFlooded
SWMM NodeFlooding MaxFloodRate
SWMM StorageVolume AvgVolume
SWMM StorageVolume AvgPctFull
SWMM StorageVolume MaxVolume
SWMM StorageVolume MaxPctFull
SWMM StorageVolume MaxOutflow
SWMM OutfallLoad MaxFlow
SWMM OutfallLoad FlowVolume
SWMM OutfallLoad PollutantMass
SWMM Pumping OnlineTime
SWMM Pumping TotalEnergy


Description of block "ValueFromSeries"

Parameter Beschreibung
EvalZeitraum
(optional)		 Bestimmt den Zeitraum, für den die Zielfunktion ausgewertet werden soll.

Format: dd.mm.yyyy hh:mm
Wenn nicht angegeben, wird der Simulationszeitraum verwendet.

WertTyp Gibt an wie der Wert, der mit dem Referenzwert verglichen werden soll, aus dem Simulationsergebnis berechnet werden soll.
  • MaxWert: Maximaler Wert des Simulationsergebnisses
  • MinWert: Minimaler Wert des Simulationsergebnisses
  • Average: Durchschnittlicher Wert des Simulationsergebnisses
  • AnfWert: Der erste wert des Simulationsergebnisses
  • EndWert: Der letzte Wert des Simulationsergebnisses
  • Summe: Summe des Simulationsergebnisses
RefWert Der zu vergleichende Referenzwert


Description of block "IHA-Analysis"

Parameter Beschreibung
EvalZeitraum
(optional)		 Bestimmt den Zeitraum, für den die Zielfunktion ausgewertet werden soll.

Format: dd.mm.yyyy hh:mm
Wenn nicht angegeben, wird der Simulationszeitraum verwendet.

RefGröße
(nur bei Referenzreihen und .WEL als Referenzdatei)		 Gibt an welche Spalte der .WEL Referenzdatei zum Vergleich herangezogen werden soll.
RefDatei Der Dateiname der Referenzreihe (.zre oder .wel)
Achtung: Die Zeitschrittweite der Referenzreihe muss mit dem Zeitschritt der Simulation übereinstimmen! (siehe Bug 218)

Literaturangaben

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