Share
 
 

Schedule Hydraulic Run view

Use the Schedule Hydraulic Run view to set up and run InfoWorks WS Pro simulations.

The behaviour of the Schedule Hydraulic Run view has changed to improve the operation.

  • Starting version 2023.1, the parameter set up messages are not produced until Save or Run are clicked.

  • When a run produces results it becomes read only to preserve the integrity. In order to edit the run, click the Clone button to create a copy of the run which can then be edited, and it adds a ! in the run name. When you click Save or Run, the new run will be saved in the Run group. If Experimental is set, then the Run dialog is editable.

The run information will be stored when the Save button is clicked, or after the simulations have been run by clicking the Run button.

Run information will be saved when simulations have been run, even if the simulations fail.

The dialog can be resized for convenience. It can be enlarged or maximized in which extra white space appears. You can also reduce the size of the dialog in which case scroll bars will appear. The size and layout of dialog components, such as buttons, does not change.

The Schedule Hydraulic Run view is opened from the Model Group window by:

  • Right-clicking Run Group and selecting New | Run.
  • Right-clicking an existing run and selecting Open.

An example of the Schedule Hydraulic Run View for an on-premise run:

An example of the Schedule Hydraulic Run View for a cloud run:

Note: The username of the "reserving user" is included in the title bar of reserved runs.

Dialog item Description
Title A title for the run. If you do not enter a title, a title will be generated automatically. The software will not allow you to give the run the same name as an existing run in the database.
Experimental

You can check this box if you wish to make changes between runs and overwrite results from the previous run. If this box has been checked the simulation can be re-run with the same run title, even if parameters have been changed in the Schedule Hydraulic Run view.

Once a simulation has been carried out with the box unchecked, configuration management is enforced. If any changes are made to parameters in the Schedule Hydraulic Run view, the results must be saved to a different file (that is, a new run title must be specified). You can use the facilities in results management to delete unwanted data.

Note: This option is not available in cloud database.

Run Type

Run type (drop-down list)

A drop-down list of available run types:

The Options button will be enabled if there are additional parameters to be set. Click the Options button to display the appropriate dialog for the run type.

Note: Some options in the drop-down list are not available in cloud database.

Cost Management

You can check this box if you want to carry out cost management simulations during the run.

Options are set in the Cost Management Options dialog. Pressing the adjacent Options button opens this dialog.

Cost management simulations can be carried out for runs of run type Normal or Water Quality. An Electricity Tariff is a required item when running optimisation.

Note: This option is not available in cloud database.

Disconnected system

You can check this box to carry out a simulation using a disconnected network. If you do not check this box, the simulation engine will treat the disconnection as an error.

See Modelling a disconnected system.

Generalised Multi Run (GMR)

You can check this box if you want to carry out a generalised multi run.

Options can be set by pressing the Generalised Multi Run Options button. See Generalised Multi Run Options dialog.

GMR can be carried out for runs of Run Type Normal, Water Quality, or InfoWorks TS.

GMR allows you to repeat a run of your choice with numerous variations on the core theme. The GMR produces a single summary report that can be viewed as a grid or as a colored theme in the GeoPlan. Refer to Viewing GMR results: Grid Report and GeoPlan for more information.

Pressure Related Demand

You can check this box if you want to use pressure related demand during the run.

Pressure related demand options are set in the Pressure Related Demand Options dialog. Pressing the adjacent Options button opens this dialog.

You can use pressure related demand with any of the run types listed above.

Sustainability (CO2)

You can check this box to carry out sustainability calculations during the run.

Sustainability options are set in the Sustainability Options dialog. Pressing the adjacent Options button opens this dialog.

Note: This option is not available in cloud database.
Run Parameters

Start, End and Timestep

When a run is first created, the Run Parameters will be set to the default values defined in the Options dialog - Run Defaults page.

The Start, End, and Timestep settings will be calculated automatically from the selected Control Set, unless you have set the values manually beforehand. In this case they will not be changed.

You can alter these values manually after they have been set if required. Once altered manually, they will not be changed by the software.

If these values do not match start and end values in the Control Set, a message will be displayed and you are able to continue or abort and adjust the times. It is up to you to ensure that the times for the run fall within the time frame of the Control Data you supply.

Maximum Iterations per Timestep

The maximum number of iterations per timestep for the simulation engine. Minimum value is 30. Maximum value is 100. By default, maximum iterations per timestep will be set to the value defined in the Options dialog - Run Defaults page.

If the engine fails to reach a solution within this number of iterations, InfoWorks WS Pro by default proceeds with the run (the option to stop the run after a failed snapshot can be set in the Simulation Options dialog) and lists a warning in the log results for the simulation.

Computational Accuracy

This is the maximum flow balance error allowed in the system. By default, computational accuracy will be set to the value defined in the Options dialog - Run Defaults page.

Each link has an equation relating flow to headloss. InfoWorks tries to solve these equations for flows into and out of each node, with a flow balance within the tolerance set here.

We recommend that this tolerance be set to approximately 1% of the average model inflow. For example, for an average total inflow of 10 litres per second, the computational accuracy should be set to 0.1 litres per second.

Calculate Demand At

The point in each timestep, assuming fixed timesteps, where demand is calculated. This calculated value is applied for the whole timestep.

Result timestep

The default value, 0, ensures that results will be generated for all time steps.

Entering a value of 1 ensures that results will be generated for the main time step (and not for dynamic steps).

Entering a value of 2 ensures that results will be generated for every 2nd main time step, 3 every 3rd main time step, and so on.

Run Parameters Options

Simulation Options

Displays a list of options applicable to all run types.

See Simulation Options dialog for further information.

Physical Constants

Displays a list of advanced run parameters.

When a run is first created, the Physical Constants will be set to the default values defined in the Options dialog - Run Defaults page.

Simulation State

The state of the network at defined times during the simulation can be saved for use as the initial state of subsequent simulations.

Opens the Simulation State dialog.

Results selector

This button opens the Results Selector dialog, which you can use to select whether full results or a subset of results are generated for the run. The dialog includes the option to use a results selector item to specify a subset of results to generate, but to make use of this option you must first have created such an item in a results selector group (in the Model Group window).

In a cloud database, a newly created run will set the Result selector mode to Standard reduction. This will restrict output of results to more commonly used attributes. This improves performance. In order to change this, go to the Options for Result Selector and choose Full Results.

Validation

This is used to set whether validation is applied to a simulation (run). You may validate for:

Model - If selected, validation will be checked for the model (network and control). Available only if the run validation is also being checked.

Run - If selected, validation will be checked for the run.

Required Items

Items that are required to run a simulation:

You can add items by dragging and dropping them from the Model Group window or Explorer window onto the appropriate box, or by clicking the Browse (Browse) button and selecting the item from the displayed tree. (By default, only appropriate items are shown in the tree, but you may have to expand the parent object folder to see them.)

If the merge method of version control is being used, the Version (Version) button appears when you add a version controlled object to the box. Clicking this button opens the Select Commit dialog, which you can use to select a different version of the object, if required.

In a cloud database, the Network drop target may show an explicit version of network, or it may show "latest version".

  • A Run will always show an explicit version, unless it is a reserved Run.
  • A Reserved Run will usually show "latest version" because it uses the latest version on an ongoing basis. However, it is possible for a Reserved Run to show an explicit version if the network is not reserved, or if you choose to use an earlier commit of the network.

If you have previously defined the run using version controlled objects and are now reusing it, an update button with a red outline will appear if a later version of an object is available. Clicking this button will replace the version currently shown in the box with the latest version.

To clear a selection, click the Delete selection (Delete selection) button.

Scenarios

Choose the scenarios that you want to run by selecting the check box.

Notes:

  • When both Network and Control items are added, you will see the common scenarios.
  • When a Network item is added without adding a Control item, you will only see the scenarios of the Network, and vice versa.

When scenarios are selected for simulation, they will appear in the job grids and the explorer tree. Multiple scenarios can only be used in Normal Hydraulic runs, Water Quality, or InfoWorks TS simulations. For Fire Flow and Critical Link Analysis, you can only select one scenario for the simulation.

In the Explorer tree, the run can be opened to show a simulation result for each scenario. Scenario names are used as a prefix in the simulation name.

Optional Items

Items that can be optionally added to the run:

You can add items by dragging and dropping them from the Model Group window or Explorer window onto the appropriate box, or by clicking the Browse (Browse) button and selecting the item from the displayed tree. (By default, only appropriate items are shown in the tree, but you may have to expand the parent object folder to see them.)

If the merge method of version control is being used, the Version (Version) button appears when you add a version controlled object to the box. Clicking this button opens the Select Commit dialog, which you can use to select a different version of the object, if required.

If you have previously defined this run using version controlled objects and are now reusing it, an update button with a red outline will appear if a later version of an object is available. Clicking this button will replace the version currently shown in the box with the latest version.

Clicking the Delete selection (Delete selection) button clears the selection.

Parameter Setup Messages

Message box displaying run validation error and warning messages.

Reserve for Testing

When checking this option:

  • Only available in cloud runs that have not been run in the cloud.
  • Checking this option reserves a run for the private use of the current user. No other user may edit the run, re-run it, or open its results.
  • A dialog appears showing the option to reserve the Network and Control.
  • The reserving user may edit and re-run as often as desired.
  • Validation is turned off when a run is reserved. You can re-enable validation in the run dialog, and validation can always be performed via the network validation dialog. The reason for disabling validation is to improve the throughput of re-runs.

When unchecking this option:

  • Unchecking the option makes the run read-only.
  • The results are publicly available.
  • A dialog appears showing the option to unreserve Network and Control.
  • The Run Locally option becomes unchecked, if it was checked.
  • Also, a prompt will appear:
    • When a reserved local run is unreserved, you will be asked to re-run in the cloud so that all users can have access to the results.
    • If a reserved run has uncommitted changes in the network or control, then it is necessary to commit the changes when removing the reservation. If you click No, then the run remains reserved and no commit occurs.
Run Locally

This is applicable when the Reserve for Testing option is checked.

This option is only available in cloud database, and is only available for the reserving user.

Selecting this option will cause the simulation to run on the client PC. This option will improve the throughput of re-runs for simpler cases such as normal and water quality runs, but cloud resources should be used for multi-runs, such as CLA, GMR, and Fire Flow.

Note: Models in cloud databases cannot make use of on-prem clusters of agents; they are restricted to the client PC.
Results Shows Local or Server, depending on how the Store results (set in new runs) option has been set in the Schedule Run(s) dialog (opened by pressing the Schedule Run button).
Clone

When clicked, this creates a copy of the run which can then be edited, and it adds a ! in the run name. When you click Save, the new run will be saved in the Run group.

Schedule

Opens the Schedule Run(s) dialog.

Note: This option is not available in cloud database.
Save Saves the information in this view without running a simulation.
Note: This option is not available in cloud database.
Run or Re‑Run

Enabled when current settings in the run view are valid.

Runs the simulation.

In general, a Run with results cannot be run. Runs have fixed configurations and if their results exist there is no reason to invoke the simulation engine.

Workgroup databases:

  • The runs have the Experimental checkbox which allows Runs to be re-run.

Cloud databases:

  • If results do not exist, then a run is allowed.
    • This may occur when a Run is created by New from the Run Group context menu, or Clone from the Run context menu.
    • When a run is copied from a transportable database, this is usually without the results. In this case a run can be invoked.
    • If the user decide to delete results, then a run is allowed to regenerate results.
  • If a run is Reserved for Testing, then a run is always possible. This supports a constant cycle of edit > run > edit > run.
  • If a run is reserved to a different user, then the simulation engine cannot be invoked.
Note: In cloud database, when the quota used is exceeded, a message will appear after clicking Run/Re-Run that your monthly quota has been used for cloud simulations. If the monthly quota is exceeded, simulations will still be run but in sequence rather than simultaneously (in parallel). When the quota is reset at the start of the next month, jobs will be processed in parallel until the monthly quota is reached. See Cloud Simulation usage for further information.
Note: When you do a re-run and you have grid or graph reports open, it will ask you if you would like to close them. If you select No or Cancel, then it will cancel the run. For any quick grids or graphs that are open, it will remove the results. When another simulation is dropped onto the network, the quick grids and graphs will show the results for the new simulation.
Parent topic: About simulations

Was this information helpful?