OPT-file: Difference between revisions
(translation) |
|||
Line 1: | Line 1: | ||
{{ | {{Template:BlueM.Opt input files}} | ||
This file defines the parameters that are to be optimized. Each line corresponds to one optimization parameter. Each optimization parameter can be used to calculate one or more [[MOD-file|model parameters]]. | |||
This file must have the same filename as the rest of the simulation dataset but have the file extension '''<code>.OPT</code>''', and be located in the same directory as the rest of the dataset. | |||
'' | ''Example with 4 optimization parameters (calibration of a rainfall-runoff model by optimizing runoff coefficient and retention constants):'' | ||
<bluem> | <bluem> | ||
* | *Optimization parameters | ||
*===================== | *======================= | ||
* | * | ||
*|--------------|-------|-----------|--------|--------|-----------|----------|-----------| | *|--------------|-------|-------------|--------|--------|-----------|----------|-----------| | ||
*| | *| Name | Unit | Start value | Min | Max | Relation | Object | Time | | ||
*|-<---------->-|-<--->-|-<------->-|-<---->-|-<---->-|-<------->-|-<------>-|-<------->-| | *|-<---------->-|-<--->-|-<--------->-|-<---->-|-<---->-|-<------->-|-<------>-|-<------->-| | ||
| | | RunoffCoeff | - | 0.5 | 0.1 | 0.9 | | | | | ||
| | | RetConstV | - | 1 | 0.1 | 10 | | | | | ||
| | | RetConst1 | - | 1 | 0.1 | 10 | > | | | | ||
| | | RetConst2 | - | 1 | 0.1 | 10 | > | | | | ||
*|--------------|-------|-----------|--------|--------|-----------|----------|-----------| | *|--------------|-------|-------------|--------|--------|-----------|----------|-----------| | ||
</bluem> | </bluem> | ||
=== | ===Description=== | ||
:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes" | :{| cellpadding="5" cellspacing="0" border="0" class="standard stripes" | ||
|- | |- | ||
! width="100" | Parameter !! width="400" | | ! width="100" | Parameter !! width="400" | Description | ||
|- | |- | ||
| ''' | | '''Name''' || Name of the optimization parameter (arbitrary)<br/>''This name is also used in the [[MOD-file]] so that model parameters can be associated with optimization parameters'' | ||
|- | |- | ||
| ''' | | '''Unit''' || Unit of the parameter value (optional) | ||
|- | |- | ||
| ''' | | '''Start value''' || Start value for the parameter | ||
|- | |- | ||
| '''Min''' & '''Max''' || | | '''Min''' & '''Max''' || Lower and upper bound for the parameter value | ||
|- | |- | ||
| ''' | | '''Relation''' || Optional relation to another optimization parameter. The relation is defined as a constraint of the parameter's value in regard to the value of the optimization parameter on the previous line. ''(#241)'' | ||
* <code> </code> ( | * <code> </code> (no relation) | ||
* <code><</code> ( | * <code><</code> (smaller than) | ||
* <code><=</code> ( | * <code><=</code> (smaller or equal than) | ||
* <code>></code> ( | * <code>></code> (larger than) | ||
* <code>>=</code> ( | * <code>>=</code> (larger or equal than) | ||
If a relation is specified, the algorithm makes sure that the relation is always adhered to by generating new parameter values up to 1000 times if necessary, until the defined relation is true. | |||
|- | |- | ||
| ''' | | '''Object''' || Optional parameter for predictive control, used for determining an unambiguous order for the moving time frame. Has to consist of the combination "OBJECT Name ATTRIBUTE", e.g. "ORIFICE Gate SETTING". Only used by [[BlueM.MPC]]. | ||
|- | |- | ||
| ''' | | '''Time''' || Optional parameter for predictive control, used for determining an unambiguous order for the moving time frame. Only used by [[BlueM.MPC]]. | ||
|} | |} | ||
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. | |||
[[ | [[Category:BlueM.Opt input files|O]] |
Revision as of 01:43, 22 January 2018
BlueM.Opt | Download | Usage | Development
BlueM.Opt input files: MOD · OPT · OBF · CON
This file defines the parameters that are to be optimized. Each line corresponds to one optimization parameter. Each optimization parameter can be used to calculate one or more model parameters.
This file must have the same filename as the rest of the simulation dataset but have the file extension .OPT
, and be located in the same directory as the rest of the dataset.
Example with 4 optimization parameters (calibration of a rainfall-runoff model by optimizing runoff coefficient and retention constants):
*Optimization parameters *======================= * *|--------------|-------|-------------|--------|--------|-----------|----------|-----------| *| Name | Unit | Start value | Min | Max | Relation | Object | Time | *|-<---------->-|-<--->-|-<--------->-|-<---->-|-<---->-|-<------->-|-<------>-|-<------->-| | RunoffCoeff | - | 0.5 | 0.1 | 0.9 | | | | | RetConstV | - | 1 | 0.1 | 10 | | | | | RetConst1 | - | 1 | 0.1 | 10 | > | | | | RetConst2 | - | 1 | 0.1 | 10 | > | | | *|--------------|-------|-------------|--------|--------|-----------|----------|-----------|
Description
Parameter Description Name Name of the optimization parameter (arbitrary)
This name is also used in the MOD-file so that model parameters can be associated with optimization parametersUnit Unit of the parameter value (optional) Start value Start value for the parameter Min & Max Lower and upper bound for the parameter value Relation Optional relation to another optimization parameter. The relation is defined as a constraint of the parameter's value in regard to the value of the optimization parameter on the previous line. (#241) <
(smaller than)<=
(smaller or equal than)>
(larger than)>=
(larger or equal than)
If a relation is specified, the algorithm makes sure that the relation is always adhered to by generating new parameter values up to 1000 times if necessary, until the defined relation is true.
Object Optional parameter for predictive control, used for determining an unambiguous order for the moving time frame. Has to consist of the combination "OBJECT Name ATTRIBUTE", e.g. "ORIFICE Gate SETTING". Only used by BlueM.MPC. Time Optional parameter for predictive control, used for determining an unambiguous order for the moving time frame. Only used by BlueM.MPC.
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.