CON-file: Difference between revisions

From BlueM
Jump to navigation Jump to search
(translation)
(→‎Description: BlueM.Opt v1.9.2: any filetype accepted as threshold series)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:BlueM.Opt input files}}
{{Template:BlueM.Opt input files}}
<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.
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 '''<code>.CON</code>''', and be located in the same directory as the rest of the dataset.
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.


A constraint is evaluated by comparing a simulated value to a threshold value, which may be defined either as a lower or upper bound.
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 2 constraints:''
''Example for a reservoir in [[BlueM.Sim]] with 3 constraints:''
<bluem>
<bluem>
*Constraints
*Constraints
*===========
*===========
*
*
*|-------------|------------|------|-----------|-------------|-----------------|------------------------|
*|-------------|------------|------|-----------|---------|-----------------|------------------------|
*|            |            |      |          |             | Threshold value | Threshold series      |
*|            |            |      |          |         | Threshold value | Threshold series      |
*| Name        | ThreshType | File | SimResult | Lower/Upper | Type    | Value | Name | File            |
*| Name        | ThreshType | File | SimResult | Bound  | Type    | Value | Name | File            |
*|-------------|------------|------|-----------|-------------|---------|-------|------|-----------------|
*|-------------|------------|------|-----------|---------|---------|-------|------|-----------------|
  | Spill      | Wert      |  WEL | TOLF_QH2  | Obergrenze  | MinWert |    0  |      |                |
  | Spill      | Value      |  WEL | TOLF_QH2  | Upper  | Min    |    0  |      |                |
  | FloodBuffer | Reihe      |  WEL | TOLF_VOL  | Obergrenze  |        |      | HWSR | FloodBuffer.wel |
  | FloodBuffer | Series    |  WEL | TOLF_VOL  | Upper  |        |      | HWSR | FloodBuffer.wel |
*|-------------|------------|------|-----------|-------------|---------|-------|------|-----------------|
| MinStorage  | Value      |  WEL | TOLF_VOL  | Lower  | Min    |  200  |      |                |
*|-------------|------------|------|-----------|---------|---------|-------|------|-----------------|
</bluem>
</bluem>


Line 30: Line 36:
|  
|  
Threshold type
Threshold type
* <code>Wert</code>: Constant threshold value
* <code>Value</code>: Constant threshold value
* <code>Reihe</code>: Time series of threshold values
* <code>Series</code>: Time series of threshold values
|-
|-
| '''File''' || The simulation result file containing the simulation result which should be checked for threshold violation. Accepted values:
| '''File''' || The simulation result file containing the simulation result which should be checked for threshold violation. Accepted values:
*<code>WEL</code>
* <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]])
|-
|-
| '''SimResult''' || The identifier of the simulation result which should be checked for threshold violation.
| '''SimResult''' || The identifier of the simulation result which should be checked for threshold violation.
|-
|-
| '''Lower/Upper''' || Specifies whether the threshold is a lower or upper bound. Accepted values:
| '''Bound''' || Specifies whether the threshold is a lower or upper bound. Accepted values:
* <code>Obergrenze</code>: Upper bound
* <code>Upper</code>: Upper bound
* <code>Untergrenze</code>: Lower bound
* <code>Lower</code>: Lower bound
|-
|-
|colspan=2| '''Threshold value'''<br/>(only used when '''ThreshType''' is <code>Wert</code> (a constant value))
|colspan=2| '''Threshold value'''<br/>(only used when '''ThreshType''' is <code>Value</code>)
|-
|-
| '''Type''' || Specifies how to calculate the value that should be compared to the threshold vaslue from the simulation result.
| '''Type''' || Specifies how to calculate the value that should be compared to the threshold value from the simulation result.
* <code>MaxWert</code>: Maximum value of the simulation result
* <code>Max</code>: Maximum value of the simulation result
* <code>MinWert</code>: Minimum value of the simulation result
* <code>Min</code>: Minimum value of the simulation result
* <code>Average</code>: Average value of the simulation result
* <code>Avg</code>: Average value of the simulation result
* <code>AnfWert</code>: First value of the simulation result
* <code>Start</code>: First value of the simulation result
* <code>EndWert</code>: Last value of the simulation result
* <code>End</code>: Last value of the simulation result
* <code>Sum</code>: Sum of the simulation result
|-
|-
| '''Value''' || The threshold value to check against.
| '''Value''' || The threshold value to check against.
|-
|-
|colspan=2| '''Threshold series'''<br/>(only used when '''ThreshType''' is <code>Reihe</code> (a series of values))
|colspan=2| '''Threshold series'''<br/>(only used when '''ThreshType''' is <code>Series</code>)
|-
|-
| '''Name''' || Only used for threshold series files in [[WEL-Format]]. The identifier of the time series within the threshold series file.
| '''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 the threshold series file. Must be either in [[ZRE-Format|ZRE]] or [[WEL-Format]]<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>
| '''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>
|}
|}
The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!
The width of the columns can be adjusted if necessary, but the column separators (<code>|</code>) must be preserved!

Latest revision as of 07:16, 28 July 2022

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

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

Versions:

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:
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.

Retrieved from "https://wiki.bluemodel.org/index.php?title=CON-file&oldid=7698"