Result type (Water Overlay)

From Tygron Support wiki
Jump to: navigation, search

The Water Module of a Water Overlay performs complex calculations and multiple types of results can be provided.

Unique results

Each result type represents an aspect of the calculated water simulation, and is accompanied by its own legend. As can be seen in the list below, many result types are supported. The water module can record more than one result type. However, since not all result types can be stored at the same time, only the selected ones are recorded. These results will be stored in individual overlays.

There is always one general Water Overlay. The configuration for the calculation is only defined in this overlay, which makes it easier to verify and configure the used simulation parameters. Result child overlays can be added to this Water Overlay to store additional result types. The advantage of using result child overlays are that for any given water overlay, the calculation of the overlay only occurs once, rather than multiple times equal to the amount of desired result types.

It is currently only possible to add result child overlays via the configuration wizard, in the step regarding output overlays.

Naturally, the results can be seen visually. They can also be inspected in more detail, and also exported.

Changing a result type

When the result type of the Water Overlay or any of its children, is changed, the legend is updated automatically. However, the data for this new result type must still be calculated. This may result in the visual output of the overlay changing, because the unchanged data is displayed with a new legend. When changing the result types, it is recommended to force a recalculation of the overlay before inspecting the results.

List of Result Types

¹ the units between () are as displayed in the 3D client. If exported to GeoTiff the SI-convention is used: meters (m) and seconds (s).

Result types can differ in the kind of data they display, the layer (surface or underground) of which they display that information, and how that data is recorded. Different result types can monitor data in the following ways:

  • Start: The data is determined at the start of the simulation and does not change afterwards.
  • Last: The data is the latest value determined at the timestep the data is recorded. The values can increase and decrease between different timesteps. This mode is primarily used for monitoring progression.
  • Average: The data is the average value based on previous values up until the timestep the data is recorded.
  • Maximum: The data is the highest value determined up until the timestep the data is recorded. The values can only increase or stay the same, but will never decrease. This mode is primarily used to gain insight into impact; the most severe situation any point had to endure.
  • Total: The result of a running tally, counting the relevant data up until the timestep the data is recorded. The value can only increase or stay the same, but will never decrease. This mode is primarily used to gain insight into quantities rather than duration.

Notes

  • Although it is possible to duplicate the overlay, and set the copy of the overlay to a different result type, we strongly advice to use child overlays instead. Downsides of the duplication approach are:
    1. The simulation has to run in full multiple times, causing a severe increase in calculation time.
    2. When changes to the overlay's configuration have to be made those changes need to be made to all water overlays.
  • Result child overlays do not recalculate if either they or their parent is set to inactive.
  • If a calculation overlay is removed, all result child overlays of that overlay are removed as well. Separate overlays set as child overlays (such as input overlays) of the overlay will not be removed.

How-to's

See also