In order to configure an isis model in fews you must configure the adaptor with an .ini file. The structure of the file is as follows:
Introduction
The ISIS/RS adapter for the EA FFS will be driven by an INI file created by ISIS. The purpose of the file is to identify the locations and unit types of the inputs, outputs and controls of the ISIS model in a form that the adapter can read without knowledge of the ISIS DAT file format.
The file format has been developed with the following in mind:
• To minimise coding and maximise the sharing of code between the adapter and FloodWorks, the parameters are the same as those in the equivalent FloodWorks parameter file.
• The element list is generic, and should allow adapters to be developed in future for other FloodWorks algorithms such as PDM and KW with a minimum of effort. Other adapters would use the same code to read the INI file. This has resulted in a relatively verbose file. Most of the elements in the file are actually size specifications, indicating the sizes of arrays of parameters.
• The generic approach means there are several elements that will always take the same value in the ISIS adapter but which would have different values in, say, a PDM adapter.
1 Sections
The INI file is in 14 sections as follows:
1. General
2. InputDimensions
3. Inputs
4. ControlDimensions
5. Controls
6. OutputDimensions
7. Outputs
8. StatesDimensions
9. RealParameterDimensions
10. RealParameters
11. IntegerParameterDimensions
12. IntegerParameters
13. CharacterParameterDimensions
14. CharacterParameters
The sections can be in any order.
2 Parameters
The full parameter list is below, followed by endnotes explaining some of the particular ISIS values. The following definitions will be useful:
• Flow input series: QTBDY marked as being used as an input to the operational model
• Stage input series: HTBDY marked as being used as an input to the operational model
• Wind input series: component of a WIND unit marked as being used as an input to the operational model
• Simple control: GAUGE, VERTICAL SLUICE, RADIAL SLUICE, ABSTRACTION, GATED WEIR, PUMP, or BLOCKAGE marked as being used as an input to the operational model
• Flow output series: node marked as providing flow output to the operational model
• Stage output series: node marked as providing stage output to the operational model
Name Generic meaning ISIS value
General
AlgorithmID Algorithm ID IWRS2
ModelID Model ID The ID of this particular ISIS model - the name specified for the export (e.g. MyModel)
InputDimensions
Total Total number of input series Number of flow or stage input series + 2 * Number of wind input series
Count0d Number of scalar sets of input series 0
Count1d Number of 1-d arrays of input series 2
Count2d Number of 2-d arrays of input series 0
Size1d Dimensions of 1d series Number of flow or stage input series, 2 * Number of wind input series
Size2d Dimensions of 2d series Omit
Inputs
IDs Location IDs for the input data streams ISIS node label for each flow or stage input,
Identifier for each wind component input stream (each separated by a comma and a space)
ControlDimensions
Total Total number of control series Number of simple controls +
5 * Number of breaches
Count0d Number of scalar sets of control series 0
Count1d Number of 1-d arrays of control series 2
Count2d Number of 2-d arrays of control series 0
Size1d Dimensions of 1d series Number of simple controls,
5 * Number of breaches
Size2d Dimensions of 2d series Omit
Controls
IDs Location IDs for the control data streams Upstream ISIS node label for each simple control,
Identifier for each breach component stream (each separated by a comma and a space)
OutputDimensions
Total Total number of output series Total number of output series
Count0d Number of scalar sets of output series 0
Count1d Number of 1-d arrays of output series 1
Count2d Number of 2-d arrays of output series 0
Size1d Dimensions of 1d series Number of output series
Size2d Dimensions of 2d series
Outputs
IDs Location IDs for the output data streams ISIS node label for each output (each separated by a comma and a space)
StatesDimensions
Total Total number of states 0
Count0d Number of scalar states 0
Count1d Number of 1-d arrays of states 0
Count2d Number of 2-d arrays of states 0
Size1d Dimensions of 1d states Omit
Size2d Dimensions of 2d states Omit
RealParameterDimensions
Total Total number of real parameters 3
Count0d Number of scalar real parameters 3
Count1d Number of 1-d arrays of real parameters 0
Count2d Number of 2-d arrays of real parameters 0
Size1d Dimensions of 1d real parameter arrays Omit
Size2d Dimensions of 2d real parameter arrays Omit
RealParameters
Values Real parameters Blank,
Timeout per 1h of simulated time (s),
Save interval (s)
IntegerParameterDimensions
Total Total number of integer parameters 2 +
Number of flow or stage input series +
Number of simple controls +
Number of output series +
2 * Number of breaches
Count0d Number of scalar integer parameters 2
Count1d Number of 1-d arrays of integer parameters 3
Count2d Number of 2-d arrays of integer parameters 1
Size1d Dimensions of 1d integer parameter arrays Number of flow or stage input series,
Number of simple controls,
Number of output series
Size2d Dimensions of 2d integer parameter arrays 2 ,
Number of breaches
IntegerParameters
Values Integer parameters Version number (currently 4),
ISIS label length (8 or 12),
Unit type for each flow or stage input series ,
Unit type for each simple control series ,
Unit type for each output series ,
Unit type and component count for each breach
CharacterParameterDimensions
Total Total number of character parameters 1 +
Number of flow or stage input series +
Number of simple controls +
Number of output series +
Number of wind input series +
2 * Number of breaches
Count0d Number of scalar character parameters 1
Count1d Number of 1-d arrays of character parameters 4
Count2d Number of 2-d arrays of character parameters 1
Size1d Dimensions of 1d character parameter arrays Number of input series,
Number of simple controls,
Number of output series,
Number of wind input series
Size2d Dimensions of 2d character parameter arrays 2 ,
Number of breaches
CharacterParameters
Values String parameters Blank,
ISIS node label for each flow or stage input,
Upstream ISIS node label for each simple control,
ISIS node label for each output,
ISIS node label for each wind input,
Upstream and downstream ISIS node label for each breach
3 Example
General
AlgorithmID=IWRS2
ModelID=Fred
InputDimensions
Total=6
Count0d=0
Count1d=2
Count2d=0
Size1d=6,0
Inputs
IDs=Cat_a, Cat_b, Cat_c, Cat_d, Cat_e, Cat_f
ControlDimensions
Total=14
Count0d=0
Count1d=2
Count2d=0
Size1d=4,10
Controls
IDs=W1U, W2U, W3U, W4U, BRCH1_U_BREACH_OFFSET, BRCH1_U_BREACH_WIDTH, BRCH1_U_BREACH_CREST, BRCH1_U_BREACH_DEPTH, BRCH1_U_BREACH_SLOPE, BRCH2_U_BREACH_OFFSET, BRCH2_U_BREACH_WIDTH, BRCH2_U_BREACH_CREST, BRCH2_U_BREACH_DEPTH, BRCH2_U_BREACH_SLOPE
OutputDimensions
Total=32
Count0d=0
Count1d=2
Count2d=0
Size1d=16,16
Outputs
IDs=S1, S2, S3, S4, S5, S6, S7, S8, S9, S10, S11, S12, S13, S14, S15, S16, S1, S2, S3, S4, S5, S6, S7, S8, S9, S10, S11, S12, S13, S14, S15, S16
StatesDimensions
Total=0
Count0d=0
Count1d=0
Count2d=0
RealParameterDimensions
Total=2
Count0d=2
Count1d=0
Count2d=0
RealParameters
Values=24.0,10.0,900.0
IntegerParameterDimensions
Total=49
Count0d=3
Count1d=3
Count2d=1
Size1d=6,4,32
Size2d=2,2
IntegerParameters
Values=4,12,1,1,1,1,1,1,22,21,38,35,1,1,1,1,1,1,1,1,1,1,1,1,1,1, 2,2,1,1,2,2,2,2,2,2,2,2,2,2,2,2,2,2,51,5,51,5
CharacterParameterDimensions
Total=47
Count0d=1
Count1d=4
Count2d=1
Size1d=6,4,32,0
Size2d=2,2
CharacterParameters
Values=, Cat_a, Cat_b, Cat_c, Cat_d, Cat_e, Cat_f, W1U, W2U, W3U, W4U, S1, S2, S3, S4, S5, S6, S7, S8, S9, S10, S11, S12, S13, S14, S15, S16, S1, S2, S3, S4, S5, S6, S7, S8, S9, S10, S11, S12, S13, S14, S15, S16, BRCH1_U, BRCH1_D, BRCH2_U, BRCH2_D
