CON-file: Difference between revisions

Latest revision as of 07:16, 28 July 2022

BlueM.Opt | Download | Usage | Development

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

Versions:

current v1.9 (starting from r1847)
v1.8 and previous (up to r1843)

This file defines the constraints for the optimization. Each line corresponds to one constraint.

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

A constraint is evaluated by comparing a simulated value to a threshold value, which may be defined either as a lower or upper bound. If a constraint is violated, the corresponding individual is marked as invalid.

Example for a reservoir in BlueM.Sim with 3 constraints:

*Constraints
*===========
*
*|-------------|------------|------|-----------|---------|-----------------|------------------------|
*|             |            |      |           |         | Threshold value | Threshold series       |
*| Name        | ThreshType | File | SimResult | Bound   | Type    | Value | Name | File            |
*|-------------|------------|------|-----------|---------|---------|-------|------|-----------------|
 | Spill       | Value      |  WEL | TOLF_QH2  | Upper   | Min     |    0  |      |                 |
 | FloodBuffer | Series     |  WEL | TOLF_VOL  | Upper   |         |       | HWSR | FloodBuffer.wel |
 | MinStorage  | Value      |  WEL | TOLF_VOL  | Lower   | Min     |  200  |      |                 |
*|-------------|------------|------|-----------|---------|---------|-------|------|-----------------|

Description

Parameter	Description
Name	Arbitrary name of the constraint
ThreshType	Threshold type `Value`: Constant threshold value `Series`: Time series of threshold values
File	The simulation result file containing the simulation result which should be checked for threshold violation. Accepted values: `WEL` (for BlueM.Sim or TALSIM) `KWL` (only for BlueM.Sim) `KTR.WEL`, `TEMP.WEL`, `CHLO.WEL` or any other result file with the ending `.WEL` (only for TALSIM)
SimResult	The identifier of the simulation result which should be checked for threshold violation.
Bound	Specifies whether the threshold is a lower or upper bound. Accepted values: `Upper`: Upper bound `Lower`: Lower bound
Threshold value (only used when ThreshType is `Value`)
Type	Specifies how to calculate the value that should be compared to the threshold value from the simulation result. `Max`: Maximum value of the simulation result `Min`: Minimum value of the simulation result `Avg`: Average value of the simulation result `Start`: First value of the simulation result `End`: Last value of the simulation result `Sum`: Sum of the simulation result
Value	The threshold value to check against.
Threshold series (only used when ThreshType is `Series`)
Name	Specifies the name of the threshold time series. Only necessary if the time series file specified under File contains multiple series (e.g. WEL file).
File	The filename of file containing the threshold time series. Warning: The time step size of the threshold series must be identical to that of the simulation result! (see #218)

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.

@@ Line 1: / Line 1: @@
-{{Vorlage:BlueM.Opt Eingabedateien}}
+{{Template:BlueM.Opt input files}}
-Diese Datei definiert die Constraints (Grenzen) für die Optimierung. Jede Zeile entspricht einem Constraint.
+<div class="info_versionen">
+'''Versions:'''
+* '''current''' v1.9 (starting from r1847)
+* [{{SERVER}}/index.php?title=CON-file&oldid=7280 v1.8 and previous] (up to r1843)
+</div>
+This file defines the constraints for the optimization. Each line corresponds to one constraint.
-Die Datei muss den gleichen Namen wie der Simulations-Datensatz haben, aber mit der Endung '''.CON''', und muss sich im Simulations-Arbeitsverzeichnis befinden. (Diese Datei ist optional!)
+The file must have the same filename as the rest of the dataset's files but have the file extension '''<code>.CON</code>''', and be located in the same directory as the rest of the dataset.
-Für die Berechnung eines Constraints wird die Differenz zwischen der Simulationsgröße und dem Grenzwert gebildet.
+A constraint is evaluated by comparing a simulated value to a threshold value, which may be defined either as a lower or upper bound. If a constraint is violated, the corresponding individual is marked as invalid.
-''Beispiel für eine Talsperre in [[BlueM.Sim]] mit 2 Constraints:''
+''Example for a reservoir in [[BlueM.Sim]] with 3 constraints:''
 <bluem>
 *Constraints
 *===========
 *
-*|---------------|----------|-------|-----------|------------|----------------------|-----------------------------|
+*|-------------|------------|------|-----------|---------|-----------------|------------------------|
-*|               |          |       |           |            |      Grenzwert       |        Grenzreihe           |
+*|             |            |      |           |         | Threshold value | Threshold series       |
-*| Bezeichnung   | GrenzTyp | Datei | SimGröße  | Oben/Unten | WertTyp  | Grenzwert | Grenzgröße | Datei          |
+*| Name        | ThreshType | File | SimResult | Bound   | Type    | Value | Name | File            |
-*|---------------|----------|-------|-----------|------------|----------|-----------|------------|----------------|
+*|-------------|------------|------|-----------|---------|---------|-------|------|-----------------|
-  | Überlauf      | Wert     |  WEL  | TOLF_QH2  | Obergrenze | MinWert  |    0      |            |                |
+  | Spill       | Value      |  WEL | TOLF_QH2  | Upper   | Min     |    0  |      |                 |
-  | HWSRaum       | Reihe    |  WEL  | TOLF_VOL  | Obergrenze |          |           | HWSR       | HWSR.wel       |
+  | FloodBuffer | Series     |  WEL | TOLF_VOL  | Upper   |         |       | HWSR | FloodBuffer.wel |
-*|---------------|----------|-------|-----------|----------- |----------|-----------|------------|----------------|
+ | MinStorage  | Value      |  WEL | TOLF_VOL  | Lower   | Min     |  200  |      |                 |
+*|-------------|------------|------|-----------|---------|---------|-------|------|-----------------|
 </bluem>
-===Spaltenbeschreibung===
+===Description===
 :{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
 |-
-! width="150" | Parameter !! width="500" | Beschreibung
+! width="150" | Parameter !! width="500" | Description
 |-
-| '''Bezeichnung''' || Bezeichnung des Constraints (beliebig)
+| '''Name''' || Arbitrary name of the constraint
 |-
-| '''GrenzTyp'''
+| '''ThreshType'''
 |
-* <code>Wert</code>: Es handelt sich um einen Grenzwert
+Threshold type
-* <code>Reihe</code>: Es handelt sich um eine Grenzwertreihe
+* <code>Value</code>: Constant threshold value
+* <code>Series</code>: Time series of threshold values
 |-
-| '''Datei''' || Die Ergebnisdatei, aus der das Simulationsergebnis ausgelesen werden soll [WEL]
+| '''File''' || The simulation result file containing the simulation result which should be checked for threshold violation. Accepted values:
+* <code>WEL</code> (for [[BlueM.Sim]] or [[TALSIM]])
+* <code>KWL</code> (only for [[BlueM.Sim]])
+* <code>KTR.WEL</code>, <code>TEMP.WEL</code>, <code>CHLO.WEL</code> or any other result file with the ending <code>.WEL</code> (only for [[TALSIM]])
 |-
-| '''SimGröße''' || Die Simulationsgröße, die auf Verletzung der Grenze überprüft werden soll
+| '''SimResult''' || The identifier of the simulation result which should be checked for threshold violation.
 |-
-| '''Oben/Unten''' || Gibt an, ob die Grenze eine Ober- oder Untergrenze darstellt.
+| '''Bound''' || Specifies whether the threshold is a lower or upper bound. Accepted values:
-* <code>Obergrenze</code>
+* <code>Upper</code>: Upper bound
-* <code>Untergrenze</code>
+* <code>Lower</code>: Lower bound
 |-
-| '''WertTyp'''<br/>(nur bei Grenzwerten) || Gibt an wie der Wert, der mit dem Grenzwert verglichen werden soll, aus dem Simulationsergebnis berechnet werden soll.
+|colspan=2| '''Threshold value'''<br/>(only used when '''ThreshType''' is <code>Value</code>)
-* <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
 |-
-| '''Grenzwert'''<br/>(nur bei Grenzwerten) || Der zu überprüfende Grenzwert
+| '''Type''' || Specifies how to calculate the value that should be compared to the threshold value from the simulation result.
+* <code>Max</code>: Maximum value of the simulation result
+* <code>Min</code>: Minimum value of the simulation result
+* <code>Avg</code>: Average value of the simulation result
+* <code>Start</code>: First value of the simulation result
+* <code>End</code>: Last value of the simulation result
+* <code>Sum</code>: Sum of the simulation result
 |-
-| '''Grenzgröße'''<br/>(nur bei Grenzwertreihen und .wel als Grenzwertdatei) || Gibt an welche Spalte der .wel Grenzwertdatei für die Grenze herangezogen werden soll.
+| '''Value''' || The threshold value to check against.
 |-
-| '''Datei'''<br/>(nur bei Grenzwertreihen) || Der Dateiname der Grenzwertdatei (.zre oder .wel)<br/><span style="color:red">'''Achtung:''' Die Zeitschrittweite der Zeitreihe muss mit dem Zeitschritt der Simulation übereinstimmen! (siehe Bug 218)</span>
+|colspan=2| '''Threshold series'''<br/>(only used when '''ThreshType''' is <code>Series</code>)
+|-
+| '''Name''' || Specifies the name of the threshold time series. Only necessary if the time series file specified under '''File''' contains multiple series (e.g. [[WEL-format|WEL file]]).
+|-
+| '''File''' || The filename of file containing the threshold time series.<br/><span style="color:red">'''Warning:''' The time step size of the threshold series must be identical to that of the simulation result! (see #218)</span>
 |}
-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!
-Ein "<code>*</code>" am Anfang einer Zeile führt dazu, dass die Zeile ignoriert wird.
+An asterisk (<code>*</code>) at the beginning of the line causes the line to be ignored.
-[[Kategorie:BlueM.Opt Eingabedateien]]
+[[Category:BlueM.Opt input files]]

CON-file: Difference between revisions

Latest revision as of 07:16, 28 July 2022

Description

Navigation menu

Search