...
Modifier | Type | Description |
|---|---|---|
| missing value modifier | time series modifier | Set the values of a time series to missing over a certain period of time |
| time series modifier | time series modifier | This modifier can be used to modify the values of a time series by defining new time value pairs. It is also possible to define an operation like add 2 or divided by 3 for a certain period. It is also possible to set all the values to missing for a certain period (comparable to the missing value modifier) |
| constant value modifier | time series modifier | Set the values of a time series to a fixed value over a certain period of time |
| enumeration modifier | time series modifier | The user can select an option from a pre-defined list of options. For each option a value will be defined which will stored in the time series. This modifier is usually applied to an empty time series. |
| single value modifier | time series modifier | This modifier can be used to apply a certain value at a certain time to a time series. |
| typical profile modifier | time series modifier | This modifier can be used to shift an existing timeseries in time. |
| mark unreliable modifier | time series modifier | This modifier can used to set the values of a modifier to unreliable over a certain period of time. |
| blending steps modifier | transformation/module parameter module | This modifier can be used to adjust the amount of "blending steps" which will be used in the adjustQ transformation. |
| disable adjustment modifier | transformation/module parameter module | With this modifier it is possible to disable the adjustQ transformation |
| time shift constant modifier | transformation/module parameter module | With this modifier it is possible to modify the amount of time steps which will be used in the timeShiftConstant transformation |
| reverse order modifier | transformation/module parameter module | With this modifier it is possible to reverse the order of the time series in the mergeSimple transformation |
| compound modifier | time series modifier | This modifier can be used to define a value at a single date/time for 1 or more time series by using sliders. |
| high low surge selection modifier | time series modifier | |
| switch option modifier | time series modifier | Modifier which can used to set a value for each time step for a set of time series. It is only possible to define a value for a one of the time series in the entire set. |
| option modifier | time series modifier | This modifier can be used to set a single value at a single time for a set of time series. It is only possible to define a value for a one of the time series in the entire set. |
| module parameter modifier | module parameter modifier | Generic module parameter modifier panel which can used for all modifiers. |
| priority modifiertime series modifier | model parameter modifier | Orders a list of priorities |
| multiple model module parameter modifier | module parameter modifier | The module parameter modifier can be used to modify multiple model parameters in a single modifier. |
| unit hydrograph modifier | module parameter modifier | The unit hydrograph modifier can be used to modify the area elevation curve of the unit hydrograph model. |
| merge weighted modifier | transformation/module parameter modifier | This modifier can be used to modify the parameters of the mergeWeighted function. |
| table rating curve modifier | time series modifier | |
| shift multiply rating curve modifier | time series modifier | The rating curve can be modified by shifting the entire curve or by multiplying the entire curve with a defined factor. |
| location attribute modifier | location attribute modifier | A modifier for modifying location attributes. |
| spatial profile modifier | time series modifier | |
| spatial copy modifier | time series modifier |
...
Modifiers can become part of a what-if by referencing the modifierType in the whatifTemplates.
Visibility of modifiers in the IFD
When a modifier is of a type without a What-if modifier type configured then the modifier is visible when the modifier is used at the selected topology node or what-if node. But when the modifier is of a type with a What-If modifier type configured then different rules apply.
| What-If modifier type | Topology Node | What-If Node |
|---|---|---|
| always apply in workflow (default) | visible when applicable for the selected node | visible when applicable for the selected node |
| never apply in what-if workflows | visible when applicable for the selected node | never visible |
| apply if referenced in what-if workflow | never visible | visible when applicable for the selected node |
| apply according to creation method | visible when applicable for the selected node | never visible |
Location attribute modifiers
...
The element <selection> can be used to predefine the list of options which are available for a certain attribute. The predefined list op of options can be defined by:
- a list of location id's,
- a location set,
- a hard-coded predefined list of options, by using the <predefined> or <predefinedInteger> elements
- a multi-value attribute which contains all the options which are available, by using the optionsControllingLocationAttributeId.
Below an example of a hard-coded list of options.
...
defaultValidTime
If this option is configured than a valid time can be chosen for this modifier. The valid time always default to time zero.
priorityModifier
Modifier by which module parameter type 'table' can be modified. This modifier presently supports reordening of the table rows for the given moduleParameterId. This moduleParameterId refers to the 'table' parameter defined in pi_modelparameters.xml. When a modifier is created, the original table values are filled in by default. It enables the user to re-order the "priorities" in the modifier display.
Transformation module parameter modifiers
...
| Code Block | ||
|---|---|---|
| ||
<mergeSimpleModifiers> <reverseOrderModifiers id="switchts" name="SWITCHTS"> <defaultStartTime>start run</defaultStartTime> <defaultEndTime>time zero</defaultEndTime> </reverseOrderModifiers> </mergeSimpleModifiers> |
defaultStartTime
The default start time of the modifier. The available options are startrun and time zero. It corresponds to the same field in the modifier display.
...
The picture below shows both the original and the referenced rating curves:
Configuration example
| Code Block | ||
|---|---|---|
| ||
<ratingCurveModifiers> <tableRatingCurveModifier id="tableRC" name="table RC"> <defaultStartTime>start run</defaultStartTime> <defaultEndTime>end run</defaultEndTime> </tableRatingCurveModifier> </ratingCurveModifiers> |
...
An example of the missing value modifier is shown below.
Configuration example
| Code Block | ||
|---|---|---|
| ||
<missingValueModifier id="setmsng" name="setmsng"> <timeSeries> <moduleInstanceId>ImportIHFSDB</moduleInstanceId> <valueType>scalar</valueType> <parameterId>STG</parameterId> <locationSetId>Gages_AK</locationSetId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="hour" multiplier="6"/> </timeSeries> <timeSeries> <moduleInstanceId>ImportIHFSDB</moduleInstanceId> <valueType>scalar</valueType> <parameterId>STG</parameterId> <locationSetId>Gages_AK</locationSetId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="hour" multiplier="1"/> </timeSeries> <defaultStartTime>start run</defaultStartTime> <defaultEndTime>end run</defaultEndTime> <resolveInWorkflow>false</resolveInWorkflow> <resolveInPlots>true</resolveInPlots> </missingValueModifier> |
...
Via "Apply To" button it is possible to apply a single modifier to an entire set of IFD-segments . In case of time series modifiers an modifiers and reverseOrderModifiers an option “create unique modifiers for each time series” segment” can also be used.
This option is only available when creating a new modifier and makes possible to create a modifier as an unique independent modifier for each of the selected segments. The option is useful when many segments need the same type of modifier but the forecaster needs to make adjustments to a subset of the initial group modifier.
...
This option is available after selecting one or more time series modifierfs modifiers in the modifiers panels in the menu which appears after a right mouse click.
...
| Code Block |
|---|
<copyModifiers> <timeSeriesModifiersPattern> <pattern>MAP</pattern> <patternDescription>MAP</patternDescription> </timeSeriesModifiersPattern> <timeSeriesModifiersPattern> <pattern>_HTMS</pattern> <patternDescription>1D</patternDescription> </timeSeriesModifiersPattern> <timeSeriesModifiersPattern> <pattern>_Delft3D_UpdateStates</pattern> <patternDescription>D3D Update States</patternDescription> </timeSeriesModifiersPattern> <timeSeriesModifiersPattern> <pattern>_Delft3D_0</pattern> <patternDescription>D3D Scenario 0</patternDescription> </timeSeriesModifiersPattern> <timeSeriesModifiersPattern> <pattern>_Delft3D_1</pattern> <patternDescription>D3D Scenario 1</patternDescription> </timeSeriesModifiersPattern> </copyModifiers> |
The configured pattern is the pattern which is actually used when copying modifiers. The pattern description is a pretty name which only used for display purposes in the "Copy modifiers dialog"
After selecting one or more time series modifiers which comply to one of the patterns defined in the copyModifiers section the option "Copy the selected time series modifiers to another module instance id" will appear in the menu.
...
The user can select a new pattern (only one) from the list. After pressing the OK button the selected time series modifiers will be copied to a new module instance id.
...